Feature: property substitution and block overhaul #395

abey79 · 2022-02-03T14:30:27Z

Description

The input provided to most commands' arguments and options may now contain substitution patterns which will be replaced by the corresponding property value.

This created the need for deferred evaluation of click-provided arguments and options. The type classes now return subclass of _DeferredEvaluator which are detected by the command decorators (@generator, etc.) and replaced by their evaluated value before they reach the command function.

In turn, implementing the above lead to the overhaul of the block processor sub-system. Block processors are now implemented as functions and the nested command have access to the current layer structure. Also, begin is now optional.

Also:

Added property substitution function to vpype_cli.State
Added mechanism to perform deferred evaluation of Click argument/option value
Added TextType and IntegerType classes to use as Click type instead of str, responding. int to perform property substitution
Updated existing types to perform property substitution
The default target layer for generators is now 1 (was new)
grid now iterates along lines first
Document.clone() now has an option to keep the layer structure/metadata (without line data)
fixed an issue where metadata dict could be shared across Doc/LC, leading to potential bugs.
fixed a bug with random when using non-square area
Various docstring fixes and improvements
assert_image_similarity now skips the test when the reference image is saved

Fixes #393

Minor bug addressed in #396

Checklist

The input provided to most commands' arguments and options may now contain substitution patterns which will be replaced by the corresponding property value. This created the need for deferred evaluation of click-provided arguments and options. The type classes now return subclass of `_DeferredEvaluator` which are detected by the command decorators (`@generator`, etc.) and replaced by their evaluated value before they reach the command function. In turn, implementing the above lead to the overhaul of the block processor sub-system. Block processors are now implemented as functions and the nested command have access to the current layer structure. * Added property substitution function to `vpype_cli.State` * Added mechanism to perform deferred evaluation of Click argument/option value * Added `TextType` class to use as Click type instead of `str` so property substitution is performed. * Updated types to perform property substitution * `grid` now iterates along lines first * Document.clone() now has an option to keep the layer structure/metadata (without line data) * fixed an issue where metadata dict could be shared across Doc/LC, leading to potential bugs. * fixed a bug with `random` when using non-square area * Various docstring fixes and improvements * `assert_image_similarity` now skips the test when the reference image is saved

Fixed doc heading level

codecov · 2022-02-03T14:51:58Z

Codecov Report

Merging #395 (cb8ee21) into master (63a44cc) will increase coverage by 0.65%.
The diff coverage is 98.58%.

@@            Coverage Diff             @@
##           master     #395      +/-   ##
==========================================
+ Coverage   92.89%   93.54%   +0.65%     
==========================================
  Files          55       56       +1     
  Lines        4587     4663      +76     
  Branches      639      648       +9     
==========================================
+ Hits         4261     4362     +101     
+ Misses        217      201      -16     
+ Partials      109      100       -9

Impacted Files	Coverage Δ
tests/conftest.py	`75.40% <ø> (+5.71%)`	⬆️
tests/test_commands.py	`98.95% <ø> (ø)`
vpype_cli/write.py	`85.71% <83.33%> (+0.80%)`	⬆️
vpype_cli/cli.py	`76.92% <88.23%> (+3.18%)`	⬆️
tests/test_hpgl.py	`100.00% <100.00%> (ø)`
tests/test_model.py	`100.00% <100.00%> (ø)`
tests/test_property_substitution.py	`100.00% <100.00%> (ø)`
vpype/model.py	`92.91% <100.00%> (+0.16%)`	⬆️
vpype_cli/blocks.py	`100.00% <100.00%> (ø)`
vpype_cli/decorators.py	`95.29% <100.00%> (+1.17%)`	⬆️
... and 9 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 63a44cc...cb8ee21. Read the comment docs.