Shared base classes for demography classes #338
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR:
demography.core
module and defines thePandasExporter
andCohorts
abstract base classes.pandas.DataFrame
and which fields need to be kept synchronized as cohorts are added or removed.PandasExporter
to many of thedemography
classes and then updates the documentation to use the newto_pandas()
method inherited from the base class.tests.unit.demographt.test_core.py
to show that the ABCs work independently and with multiple inheritance.TODO:
Cohorts
base class isn't used yet - need to think about whether to do this here. The main use case is withinCommunity
for adding new 'rows' to StemTraits, the cohort data etc. I think it's probably better to handle Revise cohort structure inside Community #336 first and then roll that ABC usage out.Cohorts
ABC name clashes withpyrealm.demography.community.Cohorts
and needs renaming:CohortMethods
or similar.pyrealm.demography.community.Canopy
attributes into cohort and community dataclasses (see Group internal attributes in Canopy into cohort and community objects. #337).Fixes #314
Type of change
Key checklist
pre-commit
checks:$ pre-commit run -a
$ poetry run pytest
Further checks