Renamed locals_in_py to self_in_py

This more accurately reflects what it controls

Author: tleonhardt

CHANGELOG.md

@@ -1,8 +1,9 @@
 ## 0.9.26 (January 26, 2020)
 * Breaking changes
+    * Renamed `locals_in_py` attribute of `cmd2.Cmd` to `self_in_py`
     * The following public attributes of `cmd2.Cmd` are no longer settable at runtime by end users:
         * `continuation_prompt`
-        * `locals_in_py`
+        * `self_in_py`
         * `prompt`
 
 ## 0.9.25 (January 26, 2020)

README.md

@@ -318,14 +318,11 @@ example/transcript_regex.txt:
 # regexes on prompts just make the trailing space obvious
 (Cmd) set
 allow_style: Terminal
-continuation_prompt: >/ /
 debug: False
 echo: False
 editor: /.*?/
 feedback_to_output: False
-locals_in_py: True
 maxrepeats: 3
-prompt: (Cmd)/ /
 quiet: False
 timing: False
 ```
@@ -350,14 +347,14 @@ Open source projects using cmd2
 
 Here are a few examples of open-source projects which use `cmd2`:
 
+* [Jok3r](http://www.jok3r-framework.com)
+    * Network & Web Pentest Automation Framework
 * [CephFS Shell](http://docs.ceph.com/docs/master/cephfs/cephfs-shell/)
     * [Ceph](https://ceph.com/) is a distributed object, block, and file storage platform
 * [JSShell](https://github.com/Den1al/JSShell)
     * An interactive multi-user web JavaScript shell
 * [psiTurk](https://psiturk.org)
     * An open platform for science on Amazon Mechanical Turk
-* [Jok3r](http://www.jok3r-framework.com)
-    * Network & Web Pentest Automation Framework
 * [Poseidon](https://github.com/CyberReboot/poseidon)
     * Leverages software-defined networks (SDNs) to acquire and then feed network traffic to a number of machine learning techniques
 * [Unipacker](https://github.com/unipacker/unipacker)

cmd2/cmd2.py

@@ -181,7 +181,7 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
         super().__init__(completekey=completekey, stdin=stdin, stdout=stdout)
 
         # Attributes which should NOT be dynamically settable via the set command at runtime
-        # To prevent a user from altering these with the py/ipy commands, remove locals_in_py from the
+        # To prevent a user from altering these with the py/ipy commands, remove self_in_py from the
         # settable dictionary during your applications's __init__ method.
         self.default_to_shell = False  # Attempt to run unrecognized commands as shell commands
         self.quit_on_sigint = False  # Quit the loop on interrupt instead of just resetting prompt
@@ -221,7 +221,7 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
         self.continuation_prompt = '> '
 
         # Allow access to your application in embedded Python shells and scripts py via self
-        self.locals_in_py = False
+        self.self_in_py = False
 
         # Commands to exclude from the help menu and tab completion
         self.hidden_commands = ['eof', '_relative_load', '_relative_run_script']
@@ -3118,7 +3118,7 @@ def py_quit():
             self.py_locals['quit'] = py_quit
             self.py_locals['exit'] = py_quit
 
-            if self.locals_in_py:
+            if self.self_in_py:
                 self.py_locals['self'] = self
             elif 'self' in self.py_locals:
                 del self.py_locals['self']
@@ -3238,7 +3238,7 @@ def load_ipy(cmd2_app: Cmd, py_bridge: PyBridge):
                 exec("{} = py_bridge".format(cmd2_app.py_bridge_name))
 
                 # Add self variable pointing to cmd2_app, if allowed
-                if cmd2_app.locals_in_py:
+                if cmd2_app.self_in_py:
                     exec("self = cmd2_app")
 
                 # Delete these names from the environment so IPython can't use them

docs/features/embedded_python_shells.rst

@@ -8,7 +8,7 @@ arguments, it enters an interactive Python session.  The session can call
 your cmd2 application while maintaining isolation.
 
 You may optionally enable full access to to your application by setting
-``locals_in_py`` to ``True``.  Enabling this flag adds ``self`` to the python
+``self_in_py`` to ``True``.  Enabling this flag adds ``self`` to the python
 session, which is a reference to your Cmd2 application. This can be useful for
 debugging your application.
 

docs/features/initialization.rst

@@ -39,7 +39,7 @@ capabilities which you may wish to utilize while initializing the app::
             self.continuation_prompt = '... '
 
             # Allow access to your application in py and ipy via self
-            self.locals_in_py = True
+            self.self_in_py = True
 
             # Set the default category name
             self.default_category = 'cmd2 Built-in Commands'
@@ -125,7 +125,7 @@ override:
   of results in a Python script or interactive console. Built-in commands don't
   make use of this.  It is purely there for user-defined commands and
   convenience.
-- **locals_in_py**: if ``True`` allow access to your application in *py*
+- **self_in_py**: if ``True`` allow access to your application in *py*
   command via ``self`` (Default: ``False``)
 - **macros**: dictionary of macro names and their values
 - **max_completion_items**: max number of CompletionItems to display during
@@ -139,7 +139,7 @@ override:
   ``app``)
 - **py_locals**: dictionary that defines specific variables/functions available
   in Python shells and scripts (provides more fine-grained control than making
-  everything available with **locals_in_py**)
+  everything available with **self_in_py**)
 - **quiet**: if ``True`` then completely suppress nonessential output (Default:
   ``False``)
 - **quit_on_sigint**: if ``True`` quit the main loop on interrupt instead of

examples/basic.py

@@ -22,7 +22,7 @@ def __init__(self):
         self.intro = style('Welcome to PyOhio 2019 and cmd2!', fg='red', bg='white', bold=True) + ' 😀'
 
         # Allow access to your application in py and ipy via self
-        self.locals_in_py = True
+        self.self_in_py = True
 
         # Set the default category name
         self.default_category = 'cmd2 Built-in Commands'

examples/cmd_as_argument.py

@@ -33,7 +33,7 @@ def __init__(self):
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(allow_cli_args=False, use_ipython=True, multiline_commands=['orate'], shortcuts=shortcuts)
 
-        self.locals_in_py = True
+        self.self_in_py = True
         self.maxrepeats = 3
         # Make maxrepeats settable at runtime
         self.settable['maxrepeats'] = 'max repetitions for speak command'

examples/hello_cmd2.py

@@ -12,6 +12,6 @@
     # Set "use_ipython" to True to include the ipy command if IPython is installed, which supports advanced interactive
     # debugging of your application via introspection on self.
     app = cmd2.Cmd(use_ipython=True, persistent_history_file='cmd2_history.dat')
-    app.locals_in_py = True     # Enable access to "self" within the py command
+    app.self_in_py = True     # Enable access to "self" within the py command
     app.debug = True            # Show traceback if/when an exception occurs
     sys.exit(app.cmdloop())

examples/initialization.py

@@ -33,7 +33,7 @@ def __init__(self):
         self.continuation_prompt = '... '
 
         # Allow access to your application in py and ipy via self
-        self.locals_in_py = True
+        self.self_in_py = True
 
         # Set the default category name
         self.default_category = 'cmd2 Built-in Commands'

examples/override_parser.py

@@ -19,6 +19,6 @@
 if __name__ == '__main__':
     import sys
     app = cmd2.Cmd(use_ipython=True, persistent_history_file='cmd2_history.dat')
-    app.locals_in_py = True     # Enable access to "self" within the py command
+    app.self_in_py = True     # Enable access to "self" within the py command
     app.debug = True            # Show traceback if/when an exception occurs
     sys.exit(app.cmdloop())