Skip to content

Add default value to nislsc python api #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zoechanzy wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add default value to nislsc python api #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3bdf708
default value: Update nislscapi_full.json
zoechanzy Aug 6, 2026
077ce2a
default value: Update files to consume default values
zoechanzy Aug 6, 2026
646ecac
default value: Add default value for library parameter
zoechanzy Aug 6, 2026
7dd42d6
default value: Update unit tests for new defaults
zoechanzy Aug 7, 2026
fdd3ed9
default value: Update examples for new defaults
zoechanzy Aug 7, 2026
0bf3a56
fix: convert integer defaults to float for double and TimeoutSeconds …
zoechanzy Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions examples/check_chassis_battery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,24 @@ def main(chassis_name: str) -> None:
reservation_timeout = 10.0

with Session.initialize_session_with_physical_channels(
None,
physical_channel_names=physical_channel_names,
connection_timeout=connection_timeout,
reservation_access=reservation_access,
reservation_group=reservation_group,
library=None,
connection_timeout=connection_timeout,
reservation_timeout=reservation_timeout,
) as session:
sensor_lower_critical = session.get_physical_channel_property_double(
physical_channel_names=physical_channel_names,
property_name="SensorLowerCritical",
physical_channel_names=physical_channel_names,
)
sensor_reading = session.get_physical_channel_property_double(
physical_channel_names=physical_channel_names,
property_name="SensorReading",
physical_channel_names=physical_channel_names,
)
health_state = session.get_physical_channel_property_string(
physical_channel_names=physical_channel_names,
property_name="HealthState",
physical_channel_names=physical_channel_names,
)
needs_replacement = sensor_reading < sensor_lower_critical

Expand Down
4 changes: 2 additions & 2 deletions examples/reset_device.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ def main(device_names: str) -> None:
reservation_timeout = 10.0

with Session.initialize_session_with_devices(
None,
device_names=device_names,
connection_timeout=connection_timeout,
reservation_access=reservation_access,
reservation_group=reservation_group,
library=None,
connection_timeout=connection_timeout,
reservation_timeout=reservation_timeout,
) as session:
session.reset_devices(device_names)
Expand Down
16 changes: 8 additions & 8 deletions examples/show_command_and_property_tree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ def get_command_and_property_tree(device_name: str) -> dict:
reservation_timeout = 10.0

with Session.initialize_session_with_devices(
None,
device_name,
connection_timeout,
reservation_access,
reservation_group,
reservation_timeout,
library=None,

@tjying95 tjying95 Aug 10, 2026

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.

Same for library. We now default this too.

connection_timeout=connection_timeout,
reservation_timeout=reservation_timeout,
) as session:

data = {
Expand All @@ -70,18 +70,18 @@ def get_command_and_property_tree(device_name: str) -> dict:
}

device_commands = session.get_device_property_string_array(
device_name,
DeviceProperty.COMMANDS,
device_name,
)

device_properties = session.get_device_property_string_array(
device_name,
DeviceProperty.PROPERTIES,
device_name,
)

device_physical_channels = session.get_device_property_string_array(
device_name,
DeviceProperty.PHYSICAL_CHANNELS,
device_name,
)

for physical_channel in device_physical_channels:
Expand Down Expand Up @@ -138,10 +138,10 @@ def get_command_and_property_tree(device_name: str) -> dict:
for physical_channel in device_physical_channels:

physical_channel_commands = session.get_physical_channel_property_string_array(
physical_channel, PhysicalChannelProperty.COMMANDS
PhysicalChannelProperty.COMMANDS, physical_channel
)
physical_channel_properties = session.get_physical_channel_property_string_array(
physical_channel, PhysicalChannelProperty.PROPERTIES
PhysicalChannelProperty.PROPERTIES, physical_channel

@tjying95 tjying95 Aug 10, 2026

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.

@bkeryan With $DefaultPhysChans and $DefaultDevices set, we have to put the physical_channel and device_name to the back. Feels a bit weird (I am still fine with it).
Alternative is having positional arguments default to None or "", then we error out if not set. But that will probably mess the docstring and IntelliSense. Thoughts?

)

for physical_channel_command in physical_channel_commands:
Expand Down
182 changes: 91 additions & 91 deletions generated/nislsc/session.py
View file
Open in desktop

Large diffs are not rendered by default.

Loading