"Interactive mode" via editable file #362

abravalheri · 2020-12-29T22:23:59Z

#333 got accidentally closed, this is a continuation of that PR.

TODO list:

Test more thoroughly and try to find/fix bugs
Hide private argparse functions (parser._actions, parser._actions) in a centralised location so they can be easily changed if necessary
Change short help text to something similar to: "Interactively choose and configure PyScaffold's parameters"
Rename --edit to -i/--interactive

… to ignore or comment options when generating examples for `--edit`

… see discussion in pyscaffold#333 for description

… this way we can also recognise custom subclasses or equivalent data types such as sets.

FlorianWilhelm

Really nice code! I really dig the implementation of the class Interactive. Tons of small functions are used like Lego to get the job done. That's clean code for me!

FlorianWilhelm · 2021-01-03T12:04:26Z

docs/examples.rst

+    from zope import subpackage
+    # zope is the namespace and subpackage is the package name
+
+  To be honest, there is really only the `Zope project <http://www.zope.org/>`_
  that comes to my mind which is using this exotic feature of Python's packaging system.
  Chances are high, that you will never ever need a namespace package in your life.


Great comment! I think statements like that help users a lot in figuring out which features are important for them.

Hi @FlorianWilhelm thanks for the comment, the original idea of mentioning Zope is yours 😝, I added the code example with the namespaces to make it more concrete...

But the sentence Chances are high, that you will never ever need a namespace package in your life. is from you right? That's the one I was referring to.

FlorianWilhelm · 2021-01-03T12:11:26Z

src/pyscaffold/extensions/interactive.py

+        config_from_ext = getattr(ext, CONFIG_KEY, fallback_config)
+        return acc | set(config_from_ext.get(kind, []))
+
+    return reduce(_reducer, list_all_extensions(), initial_value)


General note: It always takes me several minutes to understand what's happening in a reduce function and I think I am not the only one as Guido von Rossum once stated something similar. At that point, I have no better idea and this functional style is really smart but makes it also hard to understand what's going on.

I can revert it to a more procedural approach.

The main idea is to collect all the interactive configuration dicts from the extensions and merge them with CONFIG.

Or you add your last sentence as a comment just before the return statement to make it easier for future contributors to understand what's going on.

FlorianWilhelm · 2021-01-03T12:12:16Z

src/pyscaffold/extensions/interactive.py

+"""
+
+
+@lru_cache(maxsize=2)


Does this speed things up a lot? Just asking as introducing caching can always lead to quite subtle bugs later on.

So the idea is that I call this function for every action, and everytime it loads the extensions from the entrypoints (so Python goes to setuptools files collecting entries and then do some just-in-time file loading). I am not sure how long it takes, I added the cache there just intuitively to be sincere. I agree the best would be to measure before doing any premature optimisation 😅

To be fair, once all the extension classes and entrypoints are defined, this thing should be pretty much immutable (it is config metadata after all and works as a "distributed" constant across the extensions)... There could be problems if we are messing around with stubbing and mocking in the tests, but instead I am stubbing the get_config function itself instead of the things it depends on, so the cache is also taken away.

FlorianWilhelm · 2021-01-03T12:18:37Z

src/pyscaffold/shell.py


 from .exceptions import ShellCommandException
 from .log import logger

 PathLike = Union[str, os.PathLike]
+EDITORS = ("sensible-editor", "nvim", "vim", "nano", "subl", "code", "notepad", "vi")


Should we have a comment here for the Sphinx module reference?

I will add that, thank you!

abravalheri · 2021-01-03T13:23:22Z

Thank you very much for the review @FlorianWilhelm, I conducted a series of tests and tried to have 100% coverage on this extension... Hopefully it should work fine now. Just in case I added some docs saying it is experimental and asking for feedback from devs.

Hopefully this fulfils the interactive needs of PyScaffold.

FlorianWilhelm · 2021-01-03T17:51:20Z

Yes! 🥳 This was the last open todo for version 4.0, right @abravalheri? As your PR resolves issue #191.

abravalheri · 2021-01-03T17:54:53Z

Precisely! Now I guess it is just a matter of checking if the docs are in good shape, and we could have a release 😄

I am happy in terms of features for v4. I think everything else can wait until v5 (even removing --no-pyproject), with the advantage that we can have some feedback (and wait until the adoption of the newest PEPs stabilizes/is supported by setuptools).

FlorianWilhelm · 2021-01-03T18:05:55Z

So far I found the docs in quite good shape. Regarding --no-pyproject we could leave it for the time being as you suggested. So whenever you feel like it, I am happy to see a release version 4.0 :-) The honor of releasing it should be all yours as you did like 99% of all the work. I cannot thank you enough for taking so much good care of PyScaffold.

abravalheri · 2021-01-03T18:17:09Z

I will release a final beta before hand and wait a couple of weeks yet, just to be on the conservative side 😝 ...

Meanwhile I can have a look on the docs and also release updated versions of the extensions.

CarliJoy mentioned this pull request Dec 30, 2020

Add issue and pr links to doc #363

Closed

abravalheri force-pushed the editable branch 2 times, most recently from 53686d4 to f1cca87 Compare January 2, 2021 23:00

abravalheri marked this pull request as ready for review January 3, 2021 01:10

abravalheri requested a review from FlorianWilhelm January 3, 2021 01:10

abravalheri added 18 commits January 3, 2021 01:16

Add functions to generate examples of flag usages

cdcfc34

Add text editor capabilities to shell.py

db26358

Glue edit extension with shell.edit and make it happen

d183fc1

Consider better help generation for actions with nargs=* in 3.9

9369c1a

Consider the on_edit attr in extensions

eb866fc

… to ignore or comment options when generating examples for `--edit`

Add docs about the on_edit attribute in extensions

0df7744

Mention "save the file" in --edit header

ed0e2bb

Fix error with --config and --edit

b44ae5d

… see discussion in pyscaffold#333 for description

Ignore --version on edit

3db8796

Centralise places accessing argparse's non-public methods

15c69b8

Fix some bugs with --edit found during debugging

9be7e92

Prefer abc.Sequence and add abc.Set to checks in --edit

4d6bed7

… this way we can also recognise custom subclasses or equivalent data types such as sets.

Fix problem when action.const is None

6786a12

Fix store_true and store_false actions in --edit

13b45c8

Add more tests and fix bugs in the process

ac4c99c

Rename --edit to --interactive

79a2929

Finish renaming to --interactive and improve docs

5483369

Mention --interactive on the main parts of the docs

9e58de7

abravalheri force-pushed the editable branch from f1cca87 to 9e58de7 Compare January 3, 2021 01:16

FlorianWilhelm approved these changes Jan 3, 2021

View reviewed changes

FlorianWilhelm added this to the v4.0 milestone Jan 3, 2021

FlorianWilhelm added the enhancement New feature or request label Jan 3, 2021

abravalheri added 2 commits January 3, 2021 16:02

Improve readability on interactive extension

cf1f633

Small doc improvements

5f5bf08

abravalheri merged commit b6b8c9e into pyscaffold:master Jan 3, 2021

abravalheri deleted the editable branch January 3, 2021 17:48

"Interactive mode" via editable file #362

"Interactive mode" via editable file #362

abravalheri commented Dec 29, 2020 •

edited

FlorianWilhelm left a comment

FlorianWilhelm Jan 3, 2021

abravalheri Jan 3, 2021

FlorianWilhelm Jan 3, 2021

FlorianWilhelm Jan 3, 2021

abravalheri Jan 3, 2021

FlorianWilhelm Jan 3, 2021

FlorianWilhelm Jan 3, 2021

abravalheri Jan 3, 2021

FlorianWilhelm Jan 3, 2021

abravalheri Jan 3, 2021

abravalheri commented Jan 3, 2021

FlorianWilhelm commented Jan 3, 2021

abravalheri commented Jan 3, 2021 •

edited

FlorianWilhelm commented Jan 3, 2021

abravalheri commented Jan 3, 2021

		"""


		@lru_cache(maxsize=2)

"Interactive mode" via editable file #362

"Interactive mode" via editable file #362

Conversation

abravalheri commented Dec 29, 2020 • edited

FlorianWilhelm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abravalheri commented Jan 3, 2021

FlorianWilhelm commented Jan 3, 2021

abravalheri commented Jan 3, 2021 • edited

FlorianWilhelm commented Jan 3, 2021

abravalheri commented Jan 3, 2021

abravalheri commented Dec 29, 2020 •

edited

abravalheri commented Jan 3, 2021 •

edited