Add methods to register hooks, for better plugin support #462

kotfu · 2018-07-08T03:09:56Z

Add methods which allow multiple application and command processing lifecycle hooks to be registered. All registered hooks are called at the appropriate point of the application or command processing lifecycle.

Closes Improve hooks to better support plugins #410
Closes preparse() and postparse() never get called #417
Closes Fix test_which_editor_bad unit test on WSL #472 (unrelated)

The primary driver for this change is better support for plugins. Prior to this PR, if a plugin implements an application or command processing hook, the plugin will break if the cmd2.Cmd application also implements the same hook.

This PR deprecates all of the current application and command processing lifecycle hooks, except those required to retain backwards compatibility with cmd.Cmd. Complete documentation of the new system, including the now deprecated methods can be found in hooks.rst.

I have created a new plugin which implements the recently removed abbreviation behavior. The plugin can be found at https://github.com/python-cmd2/cmd2-abbrev. The plugin utilizes the hook methods in this PR.

I have also created a plugin template project (https://github.com/python-cmd2/cmd2-plugin-template) which implements a sample plugin and includes best practices and recommendations for plugin developers.

TODO:

Make sure preparse gets called for backwards compatibility reasons
Also update documentation in hooks.rst to show when this gets called
Consider adding a list of hooks analogous to preparse
Updated documentation in integrating.rst

# Conflicts: # cmd2/cmd2.py

…tions

…lugin_functions

tleonhardt · 2018-07-16T22:58:46Z

setup.py

 """.splitlines())))

-INSTALL_REQUIRES = ['pyperclip >= 1.5.27', 'colorama']
+INSTALL_REQUIRES = ['pyperclip >= 1.5.27', 'colorama', 'attrs']


Anytime we add a dependency we should updated the README.md accordingly since we have a section which discusses the required dependencies.

tleonhardt · 2018-07-16T23:02:17Z

tests/test_parsing.py

+    parser = StatementParser()
+    return parser
+
+def test_parse_empty_string_default(default_parser):


Thanks for adding the extra unit tests

tleonhardt · 2018-07-16T23:03:16Z

cmd2/cmd2.py

        backwards compatibility with the standard library version of cmd.
        """
-        statement = self.statement_parser.parse(line)
+        statement = self.statement_parser.parse(self.preparse(line))


Thanks for making sure preparse now properly gets called

tleonhardt · 2018-07-16T23:03:41Z

cmd2/cmd2.py

-        """Hook method executed just before the command line is interpreted, but after the input prompt is generated.
+        """Hook method executed before user input is parsed.
+
+        WARNING: If it's a multiline command, `preparse()` may not get all the


Good comment

tleonhardt · 2018-07-16T23:05:30Z

@kotfu
Before merging, you should update the README to mention the new dependency on attrs and the CHANGELOG to mention the overall changes.

@kmvanbrunt I know you are pretty busy at work, but if you get a chance, I would value your feedback for this PR.

Also: - Bumped version to 0.9.4 - Updated info in Readme and Sphinx docs to reflect new dependency on attrs

tleonhardt · 2018-07-17T00:39:58Z

I stared updating the CHANGELOG for you and bumped the version to 0.9.4.

I also updated the README and Sphinx docs to reflect the new dependency on attrs.

tleonhardt · 2018-07-17T00:41:15Z

CHANGELOG.md

+## 0.9.4 (TBD, 2018)
+* Bug Fixes
+    * Fixed bug where ``preparse`` wasn't getting called
+* Enhancements


Please fill in a better description of your changes

tleonhardt

This looks good to merge whenever. Lets give it a couple days to see if @kmvanbrunt can find some time to give it a look.

tleonhardt · 2018-07-17T01:29:34Z

CHANGELOG.md

+    * Fixed bug where ``preparse`` wasn't getting called
+* Enhancements
+    * Improved implementation of lifecycle hooks to to support a plugin
+      framework, see ``docs/hooks.rst`` for details.


This description looks good. Thanks for updating.

tleonhardt · 2018-07-17T22:25:36Z

I manually merged master into this PR because a conflict in test_parsing.py needed to be resolved.

@kotfu @kmvanbrunt
FYI, I am working on incorporating Visual Studio Team Services (VSTS) CI in as well since they are working on free macOS builds for open-source projects. That feature isn't fully implemented yet, so for now I am experimenting using the VSTS integration for it for free Azure-hosted Linux builds.

I will need to add a bug fix or two to this PR to get the VSTS builds passing.

tleonhardt · 2018-07-17T23:00:48Z

Sorry for temporarily breaking the build system. I should have it fixed sometime this evening.

Currently this represents VSTS Hosted Linux builds - But it is a placeholder for eventual VSTS Hosted macOS builds

tleonhardt · 2018-07-18T01:08:55Z

README.md

 [![Latest Version](https://img.shields.io/pypi/v/cmd2.svg?style=flat-square&label=latest%20stable%20version)](https://pypi.python.org/pypi/cmd2/)
 [![Build status](https://img.shields.io/travis/python-cmd2/cmd2.svg?style=flat-square&label=unix%20build)](https://travis-ci.org/python-cmd2/cmd2)
 [![Appveyor build status](https://img.shields.io/appveyor/ci/FedericoCeratto/cmd2.svg?style=flat-square&label=windows%20build)](https://ci.appveyor.com/project/FedericoCeratto/cmd2)
+[![VSTS Build status](https://python-cmd2.visualstudio.com/cmd2/_apis/build/status/cmd2-Python%20package-CI?branch=master)](https://python-cmd2.visualstudio.com/cmd2/_build/latest?definitionId=1&branch=master)


The cmd2 PR build/test CI system is now also integrated with Visual Studio Team Services (VSTS). Currently it is doing builds for Python 3.6 and 3.7 on Linux VMs on a Windows host which is redundant with the TravisCI testing. But the idea is that eventually we will use VSTS to do our macOS testing once Microsoft's support for that feature is more complete.

tleonhardt · 2018-07-18T01:15:07Z

@kotfu The one thing this PR could really benefit from is a new example called something like hooks.py demonstrating the new methods for registering hooks.

Added typing backport dependency for Python 3.4

VSTS is now running unit tests for Python 3.6.5 on macOS - In the future we will be able to test on multiple versions of Python on macOS using VSTS, but there is currently a limitation to testing with Python installed from Homebrew

tleonhardt · 2018-07-18T17:47:22Z

@kmvanbrunt @anselor
Do either of you have any feedback before this PR gets merged in?

tleonhardt · 2018-07-20T00:31:57Z

Ok @kmvanbrunt wouldn’t have time to review this for another week and a half, so I’m just going to merge this PR.

kotfu added 30 commits May 26, 2018 14:01

Allow registration of multiple postparsing hooks

bc91e16

Merge branch 'master' into plugin_functions

c390a6b

Document and test postparsing hooks

4d7d98c

Preparsing hooks not feasible, discarding.

50bb3ea

Add preloop and postloop hook capabilities

edb52d6

Clarify documentation and change parse() parameter name

a98fd1e

implement precommand and postcommand hooks

bf0d074

Merge branch 'master' into plugin_functions

019f69c

Differentiate between postparsing hooks and precommand hooks

f616d78

Merge branch 'master' into plugin_functions

3b49e52

# Conflicts: # cmd2/cmd2.py

Add more whitespace

4b87d49

Merge branch 'master' into plugin_functions

f736957

Merge branch 'master' into plugin_functions

b0965f1

Fix typo

a125027

Clean up imports

2fed217

Spacing, formating, and minor copy edits.

f3676f2

Merge branch 'master' of github.com:python-cmd2/cmd2 into plugin_func…

4e2749e

…tions

Merge branch 'plugin_functions' of github.com:python-cmd2/cmd2 into p…

7313fa4

…lugin_functions

Merge branch 'master' into plugin_functions

7e1a305

Tests for precmd hooks

0490d93

reminder to check for registered function signatures

005882f

Merge branch 'master' into plugin_functions

eaf7415

Begin converting precmd to passing and returning a data object

e5a0f30

Precommand hooks now check typing of passed callables

242742b

Preloop and postloop hooks now validate signature

18b290f

Formating and light editing

57169ea

More assertions to check for string value of statement

cd928ef

Make statement feel immutable and add type hinting

53164ef

preloop and postloop hooks must declare None return type

7321cb9

add comment headers to better organize code

61523bf

kotfu added 3 commits July 15, 2018 16:21

Update description of command loop

7a2f0a2

Fix typo.

b93d66e

Add tests for StatementParser() created with no arguments.

a8ad949

tleonhardt previously approved these changes Jul 16, 2018

View reviewed changes

Started updating CHANGELOG

8b26484

Also: - Bumped version to 0.9.4 - Updated info in Readme and Sphinx docs to reflect new dependency on attrs

tleonhardt dismissed their stale review via 8b26484 July 17, 2018 00:35

tleonhardt approved these changes Jul 17, 2018

View reviewed changes

tleonhardt previously approved these changes Jul 17, 2018

View reviewed changes

kotfu added 2 commits July 16, 2018 19:12

Fix erroneous indication that ‘precmd()’ and ‘postcmd()’ are deprecated

42f095c

Changlog updates for PR#462

e87c675

kotfu dismissed tleonhardt’s stale review via e87c675 July 17, 2018 01:13

tleonhardt previously approved these changes Jul 17, 2018

View reviewed changes

Merged master with bug fix for #474

8318653

tleonhardt dismissed their stale review via 8318653 July 17, 2018 22:22

Attempt at fixing WSL unit test bug #472

d60ed53

tleonhardt added 2 commits July 17, 2018 20:18

Fix unit test on VSTS Hosted Linux agents

82c7ac4

Add VSTS build badge to README

ca26abe

Currently this represents VSTS Hosted Linux builds - But it is a placeholder for eventual VSTS Hosted macOS builds

tleonhardt previously approved these changes Jul 18, 2018

View reviewed changes

Fix documentation in regards to requirements on Python 3.4

24a21c4

Added typing backport dependency for Python 3.4

tleonhardt dismissed their stale review via 24a21c4 July 18, 2018 02:32

tleonhardt merged commit 3f737b4 into master Jul 20, 2018

tleonhardt deleted the plugin_functions branch July 20, 2018 00:32

Add methods to register hooks, for better plugin support #462

Add methods to register hooks, for better plugin support #462

Uh oh!

Conversation

kotfu commented Jul 8, 2018 • edited by tleonhardt Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tleonhardt Jul 16, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt Jul 16, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt Jul 16, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt Jul 16, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt commented Jul 16, 2018

Uh oh!

tleonhardt commented Jul 17, 2018

Uh oh!

tleonhardt Jul 17, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt left a comment

Choose a reason for hiding this comment

Uh oh!

tleonhardt Jul 17, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt commented Jul 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tleonhardt commented Jul 17, 2018

Uh oh!

tleonhardt Jul 18, 2018

Choose a reason for hiding this comment

Uh oh!

tleonhardt commented Jul 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tleonhardt commented Jul 18, 2018

Uh oh!

tleonhardt commented Jul 20, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kotfu commented Jul 8, 2018 •

edited by tleonhardt

Loading

tleonhardt commented Jul 17, 2018 •

edited

Loading

tleonhardt commented Jul 18, 2018 •

edited

Loading