Merge branch 'google:master' into package-name

Author: dukecat0

.github/dependabot.yml

@@ -0,0 +1,31 @@
+# Basic dependabot.yml file with minimum configuration for two package managers
+
+version: 2
+updates:
+  # Enable version updates for python
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels: ["dependabot"]
+    pull-request-branch-name:
+      separator: "-"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "dbieber"
+
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      gh-actions:
+        patterns:
+          - "*"  # Check all dependencies
+    labels: ["dependabot"]
+    pull-request-branch-name:
+      separator: "-"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "dbieber"

.github/scripts/build.sh

@@ -17,20 +17,15 @@
 # Exit when any command fails.
 set -e
 
-PYTHON_VERSION=${PYTHON_VERSION:-2.7}
+PYTHON_VERSION=${PYTHON_VERSION:-3.7}
 
-pip install --upgrade setuptools pip
-pip install --upgrade pylint pytest pytest-pylint pytest-runner
-pip install termcolor
-pip install hypothesis python-Levenshtein
-pip install mock
-python setup.py develop
+pip install -e .[test]
 python -m pytest  # Run the tests without IPython.
 pip install ipython
 python -m pytest  # Now run the tests with IPython.
 pylint fire --ignore=test_components_py3.py,parser_fuzz_test.py,console
-if [[ ${PYTHON_VERSION} == 3.7 ]]; then
-  # Run type-checking.
-  pip install pytype;
-  pytype -x fire/test_components_py3.py;
+if [[ ${PYTHON_VERSION} == 3.12 ]]; then
+  # Run type-checking
+  pip install ty
+  python -m ty check --python $(which python) --exclude fire/test_components_py3.py --exclude fire/console/ --exclude fire/formatting_windows.py
 fi

.github/workflows/build.yml

@@ -1,28 +1,38 @@
 name: Python Fire
 
-on: [push]
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+defaults:
+  run:
+    shell: bash
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [2.7, 3.5, 3.7, 3.8, 3.9]
+        os: ["macos-latest", "ubuntu-latest"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14.0-rc.2"]
+        include:
+          - {os: "ubuntu-22.04", python-version: "3.7"}
 
     steps:
      # Checkout the repo.
      - name: Checkout Python Fire repository
-       uses: actions/checkout@v3
+       uses: actions/checkout@v4
 
      # Set up Python environment.
      - name: Set up Python ${{ matrix.python-version }}
-       uses: actions/setup-python@v4
+       uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
 
      # Build Python Fire using the build.sh script.
      - name: Run build script
-       shell: bash
        run: ./.github/scripts/build.sh
        env:
          PYTHON_VERSION: ${{ matrix.python-version }}

CONTRIBUTING.md

@@ -40,16 +40,13 @@ In addition, the project follows a convention of:
 - Maximum line length: 80 characters
 - Indentation: 2 spaces (4 for line continuation)
 - PascalCase for function and method names.
-- No type hints, as described in [PEP 484], to maintain compatibility with
-Python versions < 3.5.
 - Single quotes around strings, three double quotes around docstrings.
 
 [Google Python Style Guide]: http://google.github.io/styleguide/pyguide.html
-[PEP 484]: https://www.python.org/dev/peps/pep-0484
 
 ## Testing
 
-Python Fire uses [Github Actions](https://github.com/google/python-fire/actions) to run tests on each pull request. You can run
+Python Fire uses [GitHub Actions](https://github.com/google/python-fire/actions) to run tests on each pull request. You can run
 these tests yourself as well. To do this, first install the test dependencies
 listed in setup.py (e.g. pytest, mock, termcolor, and hypothesis).
 Then run the tests by running `pytest` in the root directory of the repository.

MANIFEST.in

@@ -30,7 +30,7 @@ the program to the command line.
 import fire
 
 def hello(name):
-  return 'Hello {name}!'.format(name=name)
+  return f'Hello {name}!'
 
 if __name__ == '__main__':
   fire.Fire()
@@ -52,7 +52,7 @@ command line.
 import fire
 
 def hello(name):
-  return 'Hello {name}!'.format(name=name)
+  return f'Hello {name}!'
 
 if __name__ == '__main__':
   fire.Fire(hello)
@@ -76,7 +76,7 @@ We can alternatively write this program like this:
 import fire
 
 def hello(name):
-  return 'Hello {name}!'.format(name=name)
+  return f'Hello {name}!'
 
 def main():
   fire.Fire(hello)
@@ -93,7 +93,7 @@ then simply this:
 import fire
 
 def hello(name):
-  return 'Hello {name}!'.format(name=name)
+  return f'Hello {name}!'
 
 def main():
   fire.Fire(hello)
@@ -105,7 +105,7 @@ If you have a file `example.py` that doesn't even import fire:
 
 ```python
 def hello(name):
-  return 'Hello {name}!'.format(name=name)
+  return f'Hello {name}!'
 ```
 
 Then you can use it with Fire like this:
@@ -589,6 +589,25 @@ default values that you don't want to specify. It is also important to remember
 to change the separator if you want to pass `-` as an argument.
 
 
+##### Async Functions
+
+Fire supports calling async functions too. Here's a simple example.
+
+```python
+import asyncio
+
+async def count_to_ten():
+  for i in range(1, 11):
+    await asyncio.sleep(1)
+    print(i)
+
+if __name__ == '__main__':
+  fire.Fire(count_to_ten)
+```
+
+Whenever fire encounters a coroutine function, it runs it, blocking until it completes.
+
+
 ### Argument Parsing
 
 The types of the arguments are determined by their values, rather than by the

docs/guide.md

@@ -25,7 +25,7 @@ def whack(self, n=1):
 
   def bang(self, noise='bang'):
     """Makes a loud noise."""
-    return '{noise} bang!'.format(noise=noise)
+    return f'{noise} bang!'
 
 
 def main():

examples/widget/widget.py

@@ -14,11 +14,7 @@
 
 """The Python Fire module."""
 
-from __future__ import absolute_import
-from __future__ import division
-from __future__ import print_function
-
 from fire.core import Fire
 
 __all__ = ['Fire']
-__version__ = '0.5.0'
+__version__ = '0.7.1'

fire/__init__.py

@@ -18,11 +18,8 @@
 This allows using Fire with third-party libraries without modifying their code.
 """
 
-from __future__ import absolute_import
-from __future__ import division
-from __future__ import print_function
-
 import importlib
+from importlib import util
 import os
 import sys
 
@@ -57,31 +54,17 @@ def import_from_file_path(path):
   """
 
   if not os.path.exists(path):
-    raise IOError('Given file path does not exist.')
+    raise OSError('Given file path does not exist.')
 
   module_name = os.path.basename(path)
 
-  if sys.version_info.major == 3 and sys.version_info.minor < 5:
-    loader = importlib.machinery.SourceFileLoader(  # pylint: disable=no-member
-        fullname=module_name,
-        path=path,
-    )
-
-    module = loader.load_module(module_name)  # pylint: disable=deprecated-method
-
-  elif sys.version_info.major == 3:
-    from importlib import util  # pylint: disable=g-import-not-at-top,import-outside-toplevel,no-name-in-module
-    spec = util.spec_from_file_location(module_name, path)
-
-    if spec is None:
-      raise IOError('Unable to load module from specified path.')
+  spec = util.spec_from_file_location(module_name, path)
 
-    module = util.module_from_spec(spec)  # pylint: disable=no-member
-    spec.loader.exec_module(module)  # pytype: disable=attribute-error
+  if spec is None or spec.loader is None:
+    raise OSError('Unable to load module from specified path.')
 
-  else:
-    import imp  # pylint: disable=g-import-not-at-top,import-outside-toplevel,deprecated-module
-    module = imp.load_source(module_name, path)
+  module = util.module_from_spec(spec)  # pylint: disable=no-member
+  spec.loader.exec_module(module)
 
   return module, module_name
 
@@ -121,7 +104,7 @@ def import_module(module_or_filename):
     return import_from_file_path(module_or_filename)
 
   if os.path.sep in module_or_filename:  # Use / to detect if it was a filename.
-    raise IOError('Fire was passed a filename which could not be found.')
+    raise OSError('Fire was passed a filename which could not be found.')
 
   return import_from_module_name(module_or_filename)  # Assume it's a module.
 

fire/__main__.py

@@ -23,7 +23,6 @@
 import inspect
 
 from fire import inspectutils
-import six
 
 
 def Script(name, component, default_options=None, shell='bash'):
@@ -104,7 +103,7 @@ def _BashScript(name, commands, default_options=None):
 option_already_entered()
 {{
   local opt
-  for opt in ${{COMP_WORDS[@]:0:COMP_CWORD}}
+  for opt in ${{COMP_WORDS[@]:0:$COMP_CWORD}}
   do
     if [ $1 == $opt ]; then
       return 0
@@ -278,10 +277,7 @@ def _FishScript(name, commands, default_options=None):
       )
 
   return fish_source.format(
-      global_options=' '.join(
-          '"{option}"'.format(option=option)
-          for option in global_options
-      )
+      global_options=' '.join(f'"{option}"' for option in global_options)
   )
 
 
@@ -308,23 +304,24 @@ def MemberVisible(component, name, member, class_attrs=None, verbose=False):
   Returns
     A boolean value indicating whether the member should be included.
   """
-  if isinstance(name, six.string_types) and name.startswith('__'):
+  if isinstance(name, str) and name.startswith('__'):
     return False
   if verbose:
     return True
   if (member is absolute_import
       or member is division
       or member is print_function):
     return False
-  if isinstance(member, type(absolute_import)) and six.PY34:
+  if isinstance(member, type(absolute_import)):
     return False
-  if inspect.ismodule(member) and member is six:
-    # TODO(dbieber): Determine more generally which modules to hide.
+  # TODO(dbieber): Determine more generally which modules to hide.
+  modules_to_hide = []
+  if inspect.ismodule(member) and member in modules_to_hide:
     return False
   if inspect.isclass(component):
     # If class_attrs has not been provided, compute it.
     if class_attrs is None:
-      class_attrs = inspectutils.GetClassAttrsDict(class_attrs) or {}
+      class_attrs = inspectutils.GetClassAttrsDict(component) or {}
     class_attr = class_attrs.get(name)
     if class_attr:
       # Methods and properties should only be accessible on instantiated
@@ -336,14 +333,7 @@ def MemberVisible(component, name, member, class_attrs=None, verbose=False):
       tuplegetter = getattr(collections, '_tuplegetter', type(None))
       if isinstance(class_attr.object, tuplegetter):
         return False
-  if (six.PY2 and inspect.isfunction(component)
-      and name in ('func_closure', 'func_code', 'func_defaults',
-                   'func_dict', 'func_doc', 'func_globals', 'func_name')):
-    return False
-  if (six.PY2 and inspect.ismethod(component)
-      and name in ('im_class', 'im_func', 'im_self')):
-    return False
-  if isinstance(name, six.string_types):
+  if isinstance(name, str):
     return not name.startswith('_')
   return True  # Default to including the member
 
@@ -392,7 +382,7 @@ def _CompletionsFromArgs(fn_args):
   completions = []
   for arg in fn_args:
     arg = arg.replace('_', '-')
-    completions.append('--{arg}'.format(arg=arg))
+    completions.append(f'--{arg}')
   return completions
 
 
@@ -438,7 +428,7 @@ def _FormatForCommand(token):
   Returns:
     The transformed token.
   """
-  if not isinstance(token, six.string_types):
+  if not isinstance(token, str):
     token = str(token)
 
   if token.startswith('_'):