dstl / Stone-Soup

A software project to provide the target tracking community with a framework for the development and testing of tracking algorithms.
https://stonesoup.rtfd.io
MIT License
400 stars 131 forks source link

Add ImmutableMixIn and Freezable classes #715

Open erogers-dstl opened 1 year ago

erogers-dstl commented 1 year ago

For discussion: I wrote these in a separate repo for use in a internal project.

Are these something of use to the community?

erogers-dstl commented 1 year ago

Also: it is possible this shouldn't be in base.py. Would a new file be more appropriate?

codecov[bot] commented 1 year ago

Codecov Report

Base: 94.58% // Head: 94.59% // Increases project coverage by +0.01% :tada:

Coverage data is based on head (4c9dc7c) compared to base (ed7ffb0). Patch coverage: 96.77% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #715 +/- ## ========================================== + Coverage 94.58% 94.59% +0.01% ========================================== Files 172 172 Lines 8841 8903 +62 Branches 1721 1734 +13 ========================================== + Hits 8362 8422 +60 - Misses 346 347 +1 - Partials 133 134 +1 ``` | Flag | Coverage Δ | | |---|---|---| | integration | `69.89% <35.48%> (-0.24%)` | :arrow_down: | | unittests | `90.74% <96.77%> (+0.04%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/dstl/Stone-Soup/pull/715?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl) | Coverage Δ | | |---|---|---| | [stonesoup/base.py](https://codecov.io/gh/dstl/Stone-Soup/pull/715/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl#diff-c3RvbmVzb3VwL2Jhc2UucHk=) | `95.60% <96.77%> (+0.34%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.