Skip to content
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.

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

Change generic t.any in Experiment API #501

Merged
merged 4 commits into from
Feb 26, 2024
Merged

Conversation

mellis13
Copy link
Contributor

Currently, the start, stop, generate, and get_status API functions list t.any as the type for *args. However, that is not specifically true, and underlying methods like Controller.start() specify t.Union[SmartSimEntity, EntitySequence[SmartSimEntity]]. This PR updates the typing on the Experiment API functions to reflect internal API requirements.

@mellis13 mellis13 added the area: api Issues related to API changes label Feb 26, 2024
Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.75%. Comparing base (39354db) to head (067bafd).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #501   +/-   ##
========================================
  Coverage    90.75%   90.75%           
========================================
  Files           60       60           
  Lines         3838     3838           
========================================
  Hits          3483     3483           
  Misses         355      355           
Files Coverage Δ
smartsim/experiment.py 85.62% <100.00%> (ø)

Copy link
Member

@MattToast MattToast left a comment

Choose a reason for hiding this comment

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

LGTM to me pending tests!!

doc/changelog.rst Outdated Show resolved Hide resolved
@mellis13 mellis13 merged commit 36e1f44 into CrayLabs:develop Feb 26, 2024
34 checks passed
@amandarichardsonn amandarichardsonn added the repo: smartsim Issues related to SmartSim infrastructure library label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: api Issues related to API changes repo: smartsim Issues related to SmartSim infrastructure library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants