8000 Transient data cleanup · Issue #183 · hydrologie/xhydro · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Transient data cleanup #183
Open
Open
@Zeitsperre

Description

@Zeitsperre

Addressing a Problem?

Building the documentation creates many artifacts (many of which are persistent and found in docs/notebooks/_data/**). Many types of files are written there during execution of the notebooks, with no real order/organizational scheme.

Additionally, running pytest relies on class-housed testing setup code that would be better off created as pytest fixtures. As it stands currently, some functions will create/fetch remote data to be used in multiple tests; When running with pytest-xdist this causes segmentation faults due to synchronous read/write operations on these files.

Potential Solution

  • Using session-scoped pytest fixtures could help immensely with ensuring that testing data is fetched once and yielded for tests as needed.
  • The notebooks need to make use of the tempdir library and the write operations should be verified so that notebook execution order is not important.
  • We should be making use of pooch registries

We can likely work on this after merging #175 which houses an initial implementation.

Additional context

No response

Contribution

  • I would be willing/able to open a Pull Request to contribute this feature.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestnotebooksRun tests against notebooks

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0