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

refactor!: move static methods outside their respective classes #142

Merged
merged 7 commits into from
Sep 22, 2023

Conversation

mbelak-dtml
Copy link
Collaborator

This change makes the export of a report to notebook much cleaner since tricks with replacing the class name are no longer necessary, which also enables a better implementation of #82.

BREAKING CHANGE: All report sections class static methods are moved from their respective classes to module-level functions. Top-level section functions are also renamed to prevent overriding module names (e.g. edvart.report_sections.bivariate_analysis.BivariateAnalysis.bivariate_analysis -> edvart.report_sections.bivariate_analysis.show_bivariate_analysis).

This change makes the export of a report to notebook much cleaner since
tricks with replacing the class name are no longer necessary, which also
enables a better implementation of #82.

BREAKING CHANGE: All report sections class static methods are moved from their respective
classes to module-level functions.
@mbelak-dtml mbelak-dtml requested a review from lukany September 20, 2023 15:26
@mbelak-dtml mbelak-dtml self-assigned this Sep 20, 2023
edvart/report_sections/group_analysis.py Outdated Show resolved Hide resolved
edvart/report_sections/univariate_analysis.py Outdated Show resolved Hide resolved
@mbelak-dtml mbelak-dtml requested a review from lukany September 22, 2023 07:51
lukany
lukany previously approved these changes Sep 22, 2023
@lukany lukany added this pull request to the merge queue Sep 22, 2023
Merged via the queue into main with commit 2863bb4 Sep 22, 2023
@lukany lukany deleted the refactor/move-static-methods-out-of-classes branch September 22, 2023 07:59
@mbelak-dtml mbelak-dtml linked an issue Sep 25, 2023 that may be closed by this pull request
mbelak-dtml added a commit that referenced this pull request Sep 26, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in `edvart.report_sections.timeseries_analysis`: added prefix `_show`
(e.g. `edvart.report_sections.timeseries_analysis.timeseries_analysis` -> `edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
mbelak-dtml added a commit that referenced this pull request Sep 26, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in `edvart.report_sections.timeseries_analysis`: added prefix `_show`
(e.g. `edvart.report_sections.timeseries_analysis.timeseries_analysis` -> `edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
mbelak-dtml added a commit that referenced this pull request Sep 26, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in `edvart.report_sections.timeseries_analysis`: added prefix `_show`
(e.g. `edvart.report_sections.timeseries_analysis.timeseries_analysis` -> `edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
mbelak-dtml added a commit that referenced this pull request Sep 26, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in `edvart.report_sections.timeseries_analysis`: added prefix `_show`
(e.g. `edvart.report_sections.timeseries_analysis.timeseries_analysis` -> `edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
mbelak-dtml added a commit that referenced this pull request Sep 26, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in `edvart.report_sections.timeseries_analysis`: added prefix `_show`
(e.g. `edvart.report_sections.timeseries_analysis.timeseries_analysis` -> `edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
github-merge-queue bot pushed a commit that referenced this pull request Oct 1, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in
`edvart.report_sections.timeseries_analysis`: added prefix `show_` (e.g.
`edvart.report_sections.timeseries_analysis.timeseries_analysis` ->
`edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
mbelak-dtml added a commit that referenced this pull request Oct 2, 2023
Continuation of #142 for timeseries analysis.

BREAKING CHANGE: Renamed top-level functions in `edvart.report_sections.timeseries_analysis`: added prefix `_show`
(e.g. `edvart.report_sections.timeseries_analysis.timeseries_analysis` -> `edvart.report_sections.timeseries_analysis.show_timeseries_analysis`)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Move static methods out of Section classes
2 participants