Skip to content

Feature/expeye client - #85

Open
manis404 wants to merge 6 commits into
masterfrom
feature/expeye-client
Open

manis404 wants to merge 6 commits into
masterfrom
feature/expeye-client

Conversation

@manis404

Copy link
Copy Markdown
Collaborator

This adds autogenerated types used in expeye. This also adds an API client for expeye whose method names will be updated soon - these methods are therefore considered unstable until further notice.

@manis404
manis404 requested a balanced review from Copilot November 17, 2026 13:08
@manis404 manis404 self-assigned this Nov 17, 2026
@manis404
manis404 requested a review from gfrn November 17, 2026 13:08

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The generated client imports Python 3.11-only types despite declaring Python 3.9 support, and unknown HTTP status codes bypass the configured error handling by raising ValueError.

2 open issues
What changed in this PR

This PR introduces an autogenerated Expeye client and data types into lims_utils. API method names are explicitly unstable while the interface evolves.

Changes:

  • Adds serializable models, enums, and paginated response types for Expeye resources.
  • Establishes endpoint packages and synchronous/asynchronous access to /version.
  • Adds shared response, upload, and error types, typing metadata, and client dependencies.

Paths below are relative to src/lims_utils/expeye_client/, except root-level pyproject.toml.

File Description
UNSTABLE_api/​user_groups/​__init__.py Initializes user-group endpoint package.
UNSTABLE_api/​tomograms/​__init__.py Initializes tomogram endpoint package.
UNSTABLE_api/​shipments/​__init__.py Initializes shipment endpoint package.
UNSTABLE_api/​sessions/​__init__.py Initializes session endpoint package.
UNSTABLE_api/​samples/​__init__.py Initializes sample endpoint package.
UNSTABLE_api/​sample_images/​__init__.py Initializes sample-image endpoint package.
UNSTABLE_api/​robot_actions/​__init__.py Initializes robot-action endpoint package.
UNSTABLE_api/​proteins/​__init__.py Initializes protein endpoint package.
UNSTABLE_api/​proposals/​__init__.py Initializes proposal endpoint package.
UNSTABLE_api/​processing_programs/​__init__.py Initializes processing-program endpoint package.
UNSTABLE_api/​processing_jobs/​__init__.py Initializes processing-job endpoint package.
UNSTABLE_api/​persons/​__init__.py Initializes person endpoint package.
UNSTABLE_api/​pdb_entries/​__init__.py Initializes PDB-entry endpoint package.
UNSTABLE_api/​mx_lims_shipments/​__init__.py Initializes MX LIMS shipment endpoint package.
UNSTABLE_api/​motion/​__init__.py Initializes motion endpoint package.
UNSTABLE_api/​meta/​get_version_version_get.py Adds synchronous and asynchronous version requests.
UNSTABLE_api/​meta/​__init__.py Initializes metadata endpoint package.
UNSTABLE_api/​ligands/​__init__.py Initializes ligand endpoint package.
UNSTABLE_api/​grids/​__init__.py Initializes grid endpoint package.
UNSTABLE_api/​grid_squares/​__init__.py Initializes grid-square endpoint package.
UNSTABLE_api/​fluorescence_spectrums/​__init__.py Initializes fluorescence-spectrum endpoint package.
UNSTABLE_api/​energy_scans/​__init__.py Initializes energy-scan endpoint package.
UNSTABLE_api/​diffraction_plans/​__init__.py Initializes diffraction-plan endpoint package.
UNSTABLE_api/​dewars/​__init__.py Initializes dewar endpoint package.
UNSTABLE_api/​dewar_registry/​__init__.py Initializes dewar-registry endpoint package.
UNSTABLE_api/​data_collections/​__init__.py Initializes data-collection endpoint package.
UNSTABLE_api/​data_collection_groups/​__init__.py Initializes collection-group endpoint package.
UNSTABLE_api/​ctf/​__init__.py Initializes CTF endpoint package.
UNSTABLE_api/​crystals/​__init__.py Initializes crystal endpoint package.
UNSTABLE_api/​containers/​__init__.py Initializes container endpoint package.
UNSTABLE_api/​container_registry/​__init__.py Initializes container-registry endpoint package.
UNSTABLE_api/​container_inspections/​__init__.py Initializes container-inspection endpoint package.
UNSTABLE_api/​contacts/​__init__.py Initializes contact endpoint package.
UNSTABLE_api/​atlas/​__init__.py Initializes atlas endpoint package.
UNSTABLE_api/​admin_vars/​__init__.py Initializes administrative-variable endpoint package.
UNSTABLE_api/​__init__.py Initializes unstable API namespace.
types.py Defines unset values, uploads, and responses.
py.typed Marks the client as typed.
models/​validation_error_context.py Models validation-error context.
models/​user_group_out.py Models user-group responses.
models/​user_group_ldap_search_params.py Models group LDAP search parameters.
models/​user_group_has_person_out.py Models group membership responses.
models/​string_serialised_strategy_option_type_0.py Models strategy-option properties.
models/​strategy_option_screen_type_0.py Defines screening choices.
models/​state_enum.py Defines lifecycle states.
models/​shipment_with_children_out_extra_type_0_type_0.py Stores nested shipment response extras.
models/​shipment_with_children_in_extra_type_0_type_0.py Stores nested shipment request extras.
models/​shipment_safety_levels.py Defines shipment safety levels.
models/​shipment_out_extra_type_0_type_0.py Stores shipment response extras.
models/​shipment_optional_extra_type_0_type_0.py Stores optional shipment extras.
models/​shipment_in_extra_type_0_type_0.py Stores shipment request extras.
models/​session_type_out.py Models session-type responses.
models/​session_type_in.py Models session-type requests.
models/​sample_ligand_out.py Models sample–ligand associations.
models/​safety_levels.py Defines safety-level values.
models/​rotation_axis_enum.py Defines rotation axes.
models/​robot_action_out_status_type_0.py Defines robot-action response statuses.
models/​robot_action_out_action_type_type_0.py Defines robot-action response types.
models/​robot_action_optional_status_type_0.py Defines optional robot-action statuses.
models/​robot_action_optional_action_type_type_0.py Defines optional robot-action types.
models/​robot_action_in_status_type_0.py Defines robot-action request statuses.
models/​robot_action_in_action_type_type_0.py Defines robot-action request types.
models/​remove_person_from_usergroup_user_groups_usergroup_id_persons_person_delete_personas.py Defines membership-removal identifier formats.
models/​registered_container_out.py Models registered-container responses.
models/​registered_container_in.py Models container-registration requests.
models/​reduction_parameters.py Defines reduction choices.
models/​protein_with_crystals_in.py Models protein requests containing crystals.
models/​processing_status.py Defines processing statuses.
models/​processing_job_parameters_out.py Models processing-parameter responses.
models/​processing_job_parameters_out_items.py Stores response parameter mappings.
models/​processing_job_parameters_in.py Models processing-parameter requests.
models/​processing_job_parameters_in_items.py Stores request parameter mappings.
models/​person_with_role_role_type_0.py Defines person roles.
models/​person_list_uuid.py Models UUID-based person lists.
models/​person_list_str.py Models federation-ID person lists.
models/​person_list_numeric.py Models numeric-ID person lists.
models/​person_id_with_role_role_type_0.py Defines roles for person identifiers.
models/​pdb_ligand_out.py Models PDB–ligand associations.
models/​paged_user_group_out.py Models paginated user groups.
models/​paged_tomogram_out.py Models paginated tomograms.
models/​paged_shipment_out.py Models paginated shipments.
models/​paged_session_out.py Models paginated sessions.
models/​paged_sample_position_out.py Models paginated sample positions.
models/​paged_sample_out.py Models paginated samples.
models/​paged_sample_image_out.py Models paginated sample images.
models/​paged_robot_action_out.py Models paginated robot actions.
models/​paged_registered_container_out.py Models paginated registered containers.
models/​paged_protein_out.py Models paginated proteins.
models/​paged_proposal_out.py Models paginated proposals.
models/​paged_person_out.py Models paginated persons.
models/​paged_pdb_out.py Models paginated PDB entries.
models/​paged_milling_step_out.py Models paginated milling steps.
models/​paged_ligand_out.py Models paginated ligands.
models/​paged_image_quality_indicator_out.py Models paginated image-quality indicators.
models/​paged_grid_square_out.py Models paginated grid squares.
models/​paged_grid_info_out.py Models paginated grid information.
models/​paged_full_movie_out.py Models paginated movies.
models/​paged_energy_scan_out.py Models paginated energy scans.
models/​paged_diffraction_plan_out.py Models paginated diffraction plans.
models/​paged_dewar_out.py Models paginated dewars.
models/​paged_data_collection_out.py Models paginated data collections.
models/​paged_data_collection_group_out.py Models paginated collection groups.
models/​paged_crystal_out.py Models paginated crystals.
models/​paged_container_queue_out.py Models paginated container queues.
models/​paged_container_out.py Models paginated containers.
models/​paged_container_inspection_out.py Models paginated container inspections.
models/​paged_container_history_out.py Models paginated container history.
models/​mxmr_run_blob_out_map_type_type_0.py Defines response map types.
models/​mxmr_run_blob_optional_map_type_type_0.py Defines optional map types.
models/​mx_lims_shipment_urls.py Stores shipment URL mappings.
models/​mx_lims_shipment_identifiers.py Stores shipment identifier mappings.
models/​mx_lims_puck_urls.py Stores puck URL mappings.
models/​mx_lims_puck_identifiers.py Stores puck identifier mappings.
models/​mx_lims_puck_containerref.py Stores puck container references.
models/​mx_lims_pin_urls.py Stores pin URL mappings.
models/​mx_lims_pin_sampleref.py Stores pin sample references.
models/​mx_lims_pin_identifiers.py Stores pin identifier mappings.
models/​mx_lims_pin_containerref.py Stores pin container references.
models/​mx_lims_macromolecule_urls.py Stores macromolecule URL mappings.
models/​mx_lims_macromolecule_sample_urls.py Stores macromolecule-sample URLs.
models/​mx_lims_macromolecule_sample_parentsampleref.py Stores parent-sample references.
models/​mx_lims_macromolecule_sample_identifiers.py Stores macromolecule-sample identifiers.
models/​mx_lims_macromolecule_identifiers.py Stores macromolecule identifiers.
models/​mx_lims_full_shipment_version.py Defines shipment schema versions.
models/​mx_lims_full_shipment_shipment.py Maps shipment records in full shipments.
models/​mx_lims_full_shipment_puck.py Maps puck records in full shipments.
models/​mx_lims_full_shipment_pin.py Maps pin records in full shipments.
models/​mx_lims_full_shipment_macromoleculesample.py Maps sample records in full shipments.
models/​mx_lims_full_shipment_macromolecule.py Maps macromolecules in full shipments.
models/​mx_lims_full_shipment_dewar.py Maps dewar records in full shipments.
models/​mx_lims_dewar_urls.py Stores dewar URL mappings.
models/​mx_lims_dewar_identifiers.py Stores dewar identifier mappings.
models/​mx_lims_dewar_containerref.py Stores dewar container references.
models/​mx_lims_contact.py Models MX LIMS contacts.
models/​milling_step_out_status_type_0.py Defines milling response statuses.
models/​milling_step_out_beam_type_type_0.py Defines milling response beam types.
models/​milling_step_in_status_type_0.py Defines milling request statuses.
models/​milling_step_in_beam_type_type_0.py Defines milling request beam types.
models/​laser_point_list_in.py Models laser-point list requests.
models/​laser_action_out.py Models laser-action responses.
models/​laser_action_in.py Models laser-action requests.
models/​lab_contact_out.py Models laboratory-contact responses.
models/​http_validation_error.py Models HTTP validation errors.
models/​grid_square_mode.py Defines grid-square modes.
models/​grid_info_out_orientation_type_0.py Defines grid response orientations.
models/​grid_info_optional_orientation_type_0.py Defines optional grid orientations.
models/​grid_info_in_orientation_type_0.py Defines grid request orientations.
models/​get_tomograms_for_dcg_data_groups_group_id_tomograms_get_sort_by_type_0.py Defines tomogram sorting fields.
models/​file_type.py Defines processing file types.
models/​file_attachment_type.py Defines attachment types.
models/​diffraction_plan_out_scan_parameters_type_0_type_0.py Stores response scan parameters.
models/​diffraction_plan_optional_scan_parameters_type_0_type_0.py Stores optional scan parameters.
models/​diffraction_plan_in_scan_parameters_type_0_type_0.py Stores request scan parameters.
models/​diffraction_plan_experiment_type.py Defines diffraction experiment types.
models/​dewar_with_children_out_extra_type_0_type_0.py Stores nested dewar response extras.
models/​dewar_with_children_in_extra_type_0_type_0.py Stores nested dewar request extras.
models/​dewar_out_extra_type_0_type_0.py Stores dewar response extras.
models/​dewar_optional_extra_type_0_type_0.py Stores optional dewar extras.
models/​dewar_in_extra_type_0_type_0.py Stores dewar request extras.
models/​data_collection_group_out_experiment_type_type_0.py Defines collection-group response experiment types.
models/​data_collection_group_optional_experiment_type_type_0.py Defines optional collection-group experiment types.
models/​data_collection_group_in_experiment_type_type_0.py Defines collection-group request experiment types.
models/​container_load.py Models container-loading requests.
models/​collection_mode.py Defines collection modes.
models/​centring_method.py Defines centring methods.
models/​auto_proc_scaling_statistics_out_scalingstatisticstype.py Defines scaling-statistics regions.
models/​auto_proc_program_scaling_out_scaling_statistics_type_type_0.py Defines program scaling-statistics regions.
models/​atlas_type.py Defines atlas types.
models/​aperture_out.py Models aperture responses.
models/​aperture_in.py Models aperture requests.
models/​admin_var_in.py Models administrative-variable requests.
errors.py Defines unexpected-status exceptions.
__init__.py Exports client classes.
pyproject.toml Adds httpx2 and attrs dependencies.

Review effort: Balanced

@codecov

codecov Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.38%. Comparing base (fc69218) to head (8f5edf0).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #85   +/-   ##
=======================================
  Coverage   99.38%   99.38%           
=======================================
  Files           5        5           
  Lines         163      163           
=======================================
  Hits          162      162           
  Misses          1        1           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants