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

Moved all CLI-related APIs from vpype to vpype_cli #388

Merged
merged 4 commits into from
Jan 31, 2022

Conversation

abey79
Copy link
Owner

@abey79 abey79 commented Jan 31, 2022

Description

  • Command decorators (e.g. generator and friends), click.ParamType subclasses (e.g. LengthType and friends and related helper function are now moved to vpype_cli.
  • Renamed VpypeState to State.
  • All the above remains in vpype namespace but generates a warning when used.
  • Moved all deprecated API in vpype._deprecated.py
  • Removed long-deprecated APIs: Length, VectorData, convert(), convert_page_format(), PAGE_FORMAT.
  • Removed click-plugins dependence and factored in its code such as to defer plug-in loading to execution (thus avoiding circular import issues).
  • Fixed autodoc skip filter and small doc improvements.
  • Added 3rd party license file
  • Moved to black 22.1 + updated deps.

Checklist

  • feature/fix implemented
  • code formatting ok (black and isort)
  • mypy returns no error
  • tests added/updated and pytest succeeds
  • documentation added/updated
    • command docstring and option/argument help
    • README.md updated (Feature Overview)
    • CHANGELOG.md updated
    • added new command to reference.rst
    • RTD doc updated and building with no error (make clean && make html in docs/)

@abey79 abey79 force-pushed the vpypestate-refactor branch from 38a87e0 to 072d5fb Compare January 31, 2022 16:16
- Command decorators (e.g. generator and friends), click.ParamType subclasses (e.g. LengthType and friends and related helper function are now moved to `vpype_cli`.
- Renamed `VpypeState` to `State`.
- All the above remains in `vpype` namespace but generates a warning when used.
- Moved all deprecated API in `vpype._deprecated.py`
- Removed long-deprecated APIs: Length, VectorData, convert(), convert_page_format(), PAGE_FORMAT.
- Removed click-plugins dependence and factored in its code such as to defer plug-in loading to execution (thus avoiding circular import issues).
- Fixed autodoc skip filter and small doc improvements.
- Added 3rd party license file
- Moved to black 22.1 + updated deps.
@abey79 abey79 force-pushed the vpypestate-refactor branch from 072d5fb to ac1fe5e Compare January 31, 2022 16:17
@abey79 abey79 force-pushed the vpypestate-refactor branch from 48b880e to 7e4ad9a Compare January 31, 2022 16:31
@codecov
Copy link

codecov bot commented Jan 31, 2022

Codecov Report

Merging #388 (bf67511) into master (e8aab42) will decrease coverage by 0.01%.
The diff coverage is 92.85%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #388      +/-   ##
==========================================
- Coverage   92.73%   92.71%   -0.02%     
==========================================
  Files          53       55       +2     
  Lines        4542     4573      +31     
  Branches      637      637              
==========================================
+ Hits         4212     4240      +28     
- Misses        220      222       +2     
- Partials      110      111       +1     
Impacted Files Coverage Δ
vpype/config.py 97.87% <ø> (-0.03%) ⬇️
vpype/model.py 92.74% <ø> (+0.61%) ⬆️
vpype/text.py 92.50% <ø> (ø)
vpype_cli/cli.py 73.74% <61.53%> (-1.98%) ⬇️
vpype_cli/types.py 73.03% <68.75%> (ø)
vpype_cli/state.py 89.47% <89.47%> (ø)
tests/test_commands.py 98.95% <100.00%> (ø)
tests/test_show.py 96.29% <100.00%> (ø)
vpype/__init__.py 100.00% <100.00%> (ø)
vpype/_deprecated.py 100.00% <100.00%> (ø)
... and 19 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e8aab42...bf67511. Read the comment docs.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@abey79 abey79 merged commit ea2c87d into master Jan 31, 2022
@abey79 abey79 deleted the vpypestate-refactor branch January 31, 2022 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant