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.

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

Jump to bottom

Add an Operator class #98

Merged
merged 84 commits into from
Aug 29, 2023
Merged

Add an Operator class #98

merged 84 commits into from
Aug 29, 2023

Conversation

khaeru
Copy link
Owner

@khaeru khaeru commented Aug 17, 2023 •
edited
Loading

This class consolidates, with the callable/function itself, any conveniences, special handling, or logic related to adding to a Computer tasks that use the callable.

PR checklist

  • Checks all ✅
  • Update documentation
  • Update doc/whatsnew.rst

@khaeru khaeru added the enh New feature or request label Aug 17, 2023
@khaeru khaeru self-assigned this Aug 17, 2023
@codecov-commenter
Copy link

codecov-commenter commented Aug 17, 2023 •
edited
Loading

Codecov Report

Merging #98 (6c3d4e7) into main (0d4a75e) will decrease coverage by 0.46%.
The diff coverage is 95.60%.

@@             Coverage Diff             @@
##              main      #98      +/-   ##
===========================================
- Coverage   100.00%   99.54%   -0.46%     
===========================================
  Files           43       44       +1     
  Lines         3524     3696     +172     
===========================================
+ Hits          3524     3679     +155     
- Misses           0       17      +17
Files Changed Coverage Δ
genno/testing/__init__.py 100.00% <ø> (ø)
genno/compat/pyam/__init__.py 92.85% <75.00%> (-7.15%) ⬇️
genno/util.py 98.75% <87.50%> (-1.25%) ⬇️
genno/core/computation.py 89.47% <89.47%> (ø)
genno/core/key.py 96.15% <91.93%> (-3.85%) ⬇️
genno/config.py 98.68% <92.30%> (-1.32%) ⬇️
genno/core/computer.py 98.51% <95.50%> (-1.49%) ⬇️
genno/compat/plotnine/plot.py 100.00% <100.00%> (ø)
genno/compat/pyam/computations.py 100.00% <100.00%> (ø)
genno/computations.py 100.00% <100.00%> (ø)
... and 7 more

@khaeru khaeru linked an issue Aug 18, 2023 that may be closed by this pull request
Add a Computation abstract class #30
Closed
khaeru added 20 commits August 21, 2023 10:31
@khaeru
Exclude "if TYPE_CHECKING:" from coverage
d1517f4
@khaeru
Handle types through Key(), not Key.from_str_or_key()
06adc8c
@khaeru
Use fast code path in Key internals
2dacc13
@khaeru
Add Key.drop_all()
f75a7a9
@khaeru
Narrow KeyLike type variable to [Key, str]
9fb53f2
@khaeru
Update internal 1-arg calls to Key.from_str_or_key()
f13577e
@khaeru
Update Key usage in tests, docs
366a10c
@khaeru
Satisfy mypy in .core.graph
e5caedc
@khaeru
Expand tests of Key constructor
56483b2
@khaeru
Simplify Computation class
1a74576 
- Don't inherit ABC.
- Invoke type() to construct subclass with func.__name__.
- Make intelligible to functools.partial() from stdlib.
- Add repr().
- Don't pass instance to callable.
@khaeru
Remove self arguments from computation callables
927b5b3
@khaeru
Handle MissingKeyError in .config.aggregate
5662432
@khaeru
Call add_single() directly in add_load_file()
4debd89
@khaeru
Improve Computer.add_queue()
1c7e05b 
Allow individual elements to be only a task, without a mapping of
keyword arguments.

Internal to the method:
- Use a class to carry information on queue items.
- Move _log() helper outside of loop.
-
@khaeru
Preserve 1-tuple with a callable as task in add_single()
22f9397
@khaeru
Use Computation.add_tasks() in Computer.add()
4ac3644
@khaeru
Simplify Computer.add() using .add_queue() improvements
9b0eb68
@khaeru
Warn of deprecation of Computer.add_*() methods; reorder
a821133
@khaeru
Type Computation.add_tasks()
b43de5c
@khaeru
Handle more callables in partial_split()
542a4ca
khaeru added 21 commits August 28, 2023 15:55
@khaeru
Exclude lines from coverage in pyam config handler
15b8a3e
@khaeru
Document deprecated Computer methods
9ff8146
@khaeru
Test describe.label()
4b0c551
@khaeru
Adjust Operator for Sphinx compatibility
1b8c287 
- Use update_wrapper() on the instance, not class.
- Use staticmethod(…) to store references to callables.
@khaeru
Configure Sphinx to document Operator subclasses
1ba3661 
By default, Sphinx does not recognize/document these as functions.
@khaeru
Add :py: Sphinx role for highlighted inline Python
6061804
@khaeru
Update inline docs; type .pyam.computations
e60d3e9 
Use Sphinx ".. deprecated::" directive.
@khaeru
Expose Operator at the top level
d84cda4
@khaeru
Update docs for #98
d023b68 
- Use "operator", not "computation", where appropriate.
- Add .core.operator to API documentation.
@khaeru
Consolidate .pyam docs in compat-pyam; expand
5140901
@khaeru
Add #98 to doc/whatsnew
bd87006
@khaeru
Tidy missing internal references
883d33e 
Identified with "-n" option to sphinx-build.
@khaeru
Expand doc/whatsnew per #34
4af870c
@khaeru
Implement Operator.__eq__
ce25aff
@khaeru
Don't override a higher-dimensional key in add_mul
dffc820
@khaeru
Satisfy mypy per add_mul()
ddf857b
@khaeru
Implement Key.__{add,mul,truediv}__()
92367da
@khaeru
Deprecate Computer.aggregate
1aeb0c1
@khaeru
Adjust config handler for "aggregate:"
8d209ba
@khaeru
Make sum an Operator; add a helper method
b717deb
@khaeru
Adjust tests of deprecated Computer.aggregate()
4ec7ab3
@khaeru khaeru changed the title Add an Operator abstract class Add an Operator class Aug 29, 2023
@khaeru khaeru merged commit bdead68 into main Aug 29, 2023
@khaeru khaeru deleted the issue/30b branch August 31, 2023 21:07
This was referenced Nov 14, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@khaeru khaeru

Labels
enh New feature or request
Projects
None yet
Milestone
No milestone
2 participants
@khaeru @codecov-commenter