Skip to content

feat: Include UDS path in connection properties.#5172

Open
mkundu1 wants to merge 2 commits into
mainfrom
feat/uds_path_conn_prop
Open

feat: Include UDS path in connection properties.#5172
mkundu1 wants to merge 2 commits into
mainfrom
feat/uds_path_conn_prop

Conversation

@mkundu1

@mkundu1 mkundu1 commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Context

For local-connection on Linux, ip+port is replaced by UDS path which should be available within session's connection properties.

Change Summary

Include the UDS full-path in session's connection properties.

image

Rationale

The connection properties are useful to connect another client session to the same server and the UDS path is required to connect locally in Linux.

Impact

The UDS path info will be available within session's connection properties.

@mkundu1 mkundu1 linked an issue Jun 4, 2026 that may be closed by this pull request
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

IP address used to connect to Fluent.
port : int | None
Port used to connect to Fluent.
uds_fullpath : str | Path | None

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
uds_fullpath : str | Path | None
uds_full_path : str | Path | None

@mkundu1 mkundu1 Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seanpearsonuk The naming followed the parameter name in the cyberchannel module documentation. The create_channel within cyberchannel is exposed to users and we also support passing the channel within the FluentConnection constructor while directly initializing the session classes (although this is not a mainstream usage pattern). Should we change the parameter name in PyFluent or be consistent with the cyberchannel module?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RobPasMue I think that the name of the parameter in cyberchannel could be updated. WDYT?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @seanpearsonuk! We can update the cyberchannel if needed - but the update would imply accepting both options in fact, at least for a while. We could then move to deprecating the old version.

Nonetheless - what's the main driver? I'm guessing readability but just in case =)


ip: str | None = None
port: int | None = None
uds_fullpath: str | Path | None = None

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
uds_fullpath: str | Path | None = None
uds_full_path: str | Path | None = None

self._channel_str = None
self._slurm_job_id = None
self.finalizer_cbs = []
self._uds_fullpath = None

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
self._uds_fullpath = None
self._uds_full_path = None

self._channel_str = address
uds_fullpath = get_uds_path(address)
if uds_fullpath is None:
self._uds_fullpath = get_uds_path(address)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
self._uds_fullpath = get_uds_path(address)
self._uds_full_path = get_uds_path(address)

uds_fullpath = get_uds_path(address)
if uds_fullpath is None:
self._uds_fullpath = get_uds_path(address)
if self._uds_fullpath is None:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if self._uds_fullpath is None:
if self._uds_full_path is None:

ip=ip,
port=port,
uds_fullpath=uds_fullpath,
uds_fullpath=self._uds_fullpath,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
uds_fullpath=self._uds_fullpath,
uds_full_path=self._uds_full_path,

inside_container,
ip=ip,
port=port,
uds_fullpath=self._uds_fullpath,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
uds_fullpath=self._uds_fullpath,
uds_full_path=self._uds_full_path,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

connection_properties are None in linux

5 participants