Check format with black. (#31)

* Add a GH action to run the tests.

* Add a action to check format with black.

* format with black

---------

Co-authored-by: Mark McDonald <[email protected]>

Author: MarkDaoust

.github/workflows/test_pr.yaml

@@ -51,4 +51,17 @@ jobs:
         python --version
         pip install -q -e .[dev]
         python -m unittest discover --pattern '*test*.py'
-        
+  format:
+    name: Check format with black
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Check format
+      run: |
+        python --version
+        pip install -q -e .
+        pip install -q black
+        black . --check

docs/build_docs.py

@@ -120,8 +120,11 @@
 )
 
 _CODE_URL_PREFIX = flags.DEFINE_string(
-    "code_url_prefix", "https://github.com/google/generative-ai-python/blob/master/google/generativeai",
-    "where to find the project code")
+    "code_url_prefix",
+    "https://github.com/google/generative-ai-python/blob/master/google/generativeai",
+    "where to find the project code",
+)
+
 
 class MyFilter:
     def __init__(self, base_dirs):
@@ -134,9 +137,7 @@ def drop_staticmethods(self, parent, children):
                 yield name, value
 
     def __call__(self, path, parent, children):
-        if (
-                any("generativelanguage" in part for part in path)
-                or "generativeai" in path):
+        if any("generativelanguage" in part for part in path) or "generativeai" in path:
             children = self.filter_base_dirs(path, parent, children)
             children = public_api.explicit_package_contents_filter(
                 path, parent, children
@@ -158,7 +159,9 @@ def make_default_filters(self):
             public_api.add_proto_fields,
             public_api.filter_builtin_modules,
             public_api.filter_private_symbols,
-            MyFilter(self._base_dir),  # Replaces: public_api.FilterBaseDirs(self._base_dir),
+            MyFilter(
+                self._base_dir
+            ),  # Replaces: public_api.FilterBaseDirs(self._base_dir),
             public_api.FilterPrivateMap(self._private_map),
             public_api.filter_doc_controls_skip,
             public_api.ignore_typing,
@@ -186,8 +189,10 @@ def gen_api_docs():
             pathlib.Path(google.generativeai.__file__).parent,
             pathlib.Path(google.ai.generativelanguage.__file__).parent.parent,
         ),
-        code_url_prefix=(_CODE_URL_PREFIX.value,
-                         'https://github.com/googleapis/google-cloud-python/tree/main/packages/google-ai-generativelanguage/google/ai'),
+        code_url_prefix=(
+            _CODE_URL_PREFIX.value,
+            "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-ai-generativelanguage/google/ai",
+        ),
         search_hints=_SEARCH_HINTS.value,
         site_path=_SITE_PATH.value,
         callbacks=[],
@@ -216,12 +221,12 @@ def gen_api_docs():
     redirects_path.write_text(yaml.dump(redirects))
 
     # clear `oneof` junk from proto pages
-    for fpath in out_path.rglob('*.md'):
+    for fpath in out_path.rglob("*.md"):
         old_content = fpath.read_text()
         new_content = old_content
-        new_content = re.sub(r'\.\. _oneof:.*?\n', '', new_content)
-        new_content = re.sub(r'`oneof`_.*?\n', '', new_content)
-        new_content = re.sub(r'\.\. code-block:: python.*?\n', '', new_content)
+        new_content = re.sub(r"\.\. _oneof:.*?\n", "", new_content)
+        new_content = re.sub(r"`oneof`_.*?\n", "", new_content)
+        new_content = re.sub(r"\.\. code-block:: python.*?\n", "", new_content)
         if new_content != old_content:
             fpath.write_text(new_content)
 

google/generativeai/notebook/__init__.py

@@ -16,17 +16,17 @@
 
 
 def load_ipython_extension(ipython):
-  """Register the Colab Magic extension to support %load_ext."""
-  # pylint: disable-next=g-import-not-at-top
-  from google.generativeai.notebook import magics
+    """Register the Colab Magic extension to support %load_ext."""
+    # pylint: disable-next=g-import-not-at-top
+    from google.generativeai.notebook import magics
 
-  ipython.register_magics(magics.Magics)
+    ipython.register_magics(magics.Magics)
 
-  # Since we're in an interactive environment, make the tables prettier.
-  try:
-    # pylint: disable-next=g-import-not-at-top
-    from google import colab
+    # Since we're in an interactive environment, make the tables prettier.
+    try:
+        # pylint: disable-next=g-import-not-at-top
+        from google import colab
 
-    colab.data_table.enable_dataframe_formatter()
-  except ImportError:
-    pass
+        colab.data_table.enable_dataframe_formatter()
+    except ImportError:
+        pass

google/generativeai/notebook/argument_parser.py

@@ -34,79 +34,79 @@
 
 # pylint: disable-next=g-bad-exception-name
 class _ParserBaseException(RuntimeError, metaclass=abc.ABCMeta):
-  """Base class for parser exceptions including normal exit."""
+    """Base class for parser exceptions including normal exit."""
 
-  def __init__(self, msgs: Sequence[str], *args, **kwargs):
-    super().__init__("".join(msgs), *args, **kwargs)
-    self._msgs = msgs
-    self._ipython_env: ipython_env.IPythonEnv | None = None
+    def __init__(self, msgs: Sequence[str], *args, **kwargs):
+        super().__init__("".join(msgs), *args, **kwargs)
+        self._msgs = msgs
+        self._ipython_env: ipython_env.IPythonEnv | None = None
 
-  def set_ipython_env(self, env: ipython_env.IPythonEnv) -> None:
-    self._ipython_env = env
+    def set_ipython_env(self, env: ipython_env.IPythonEnv) -> None:
+        self._ipython_env = env
 
-  def _ipython_display_(self):
-    self.display(self._ipython_env)
+    def _ipython_display_(self):
+        self.display(self._ipython_env)
 
-  def msgs(self) -> Sequence[str]:
-    return self._msgs
+    def msgs(self) -> Sequence[str]:
+        return self._msgs
 
-  @abc.abstractmethod
-  def display(self, env: ipython_env.IPythonEnv | None) -> None:
-    """Display this exception on an IPython console."""
+    @abc.abstractmethod
+    def display(self, env: ipython_env.IPythonEnv | None) -> None:
+        """Display this exception on an IPython console."""
 
 
 # ParserNormalExit is not an error: it's a way for ArgumentParser to indicate
 # that the user has entered a special request (e.g. "--help") instead of a
 # runnable command.
 # pylint: disable-next=g-bad-exception-name
 class ParserNormalExit(_ParserBaseException):
-  """Exception thrown when the parser exits normally.
+    """Exception thrown when the parser exits normally.
 
-  This is usually thrown when the user requests the help message.
-  """
+    This is usually thrown when the user requests the help message.
+    """
 
-  def display(self, env: ipython_env.IPythonEnv | None) -> None:
-    for msg in self._msgs:
-      print(msg)
+    def display(self, env: ipython_env.IPythonEnv | None) -> None:
+        for msg in self._msgs:
+            print(msg)
 
 
 class ParserError(_ParserBaseException):
-  """Exception thrown when there is an error."""
+    """Exception thrown when there is an error."""
 
-  def display(self, env: ipython_env.IPythonEnv | None) -> None:
-    for msg in self._msgs:
-      print(msg)
-    if env is not None:
-      # Highlight to the user that an error has occurred.
-      env.display_html("<b style='font-family:courier new'>ERROR</b>")
+    def display(self, env: ipython_env.IPythonEnv | None) -> None:
+        for msg in self._msgs:
+            print(msg)
+        if env is not None:
+            # Highlight to the user that an error has occurred.
+            env.display_html("<b style='font-family:courier new'>ERROR</b>")
 
 
 class ArgumentParser(argparse.ArgumentParser):
-  """Customized ArgumentParser for LLM Magics.
-
-  This class overrides the parent argparse.ArgumentParser's error-handling
-  methods to avoid side-effects like printing to stderr. The messages are
-  accumulated and passed into the raised exceptions for the caller to
-  handle them.
-  """
-
-  def __init__(self, *args, **kwargs):
-    super().__init__(*args, **kwargs)
-    self._messages: list[str] = []
-
-  def _print_message(self, message, file=None):
-    """Override ArgumentParser's _print_message() method."""
-    del file
-    self._messages.append(message)
-
-  def exit(self, status=0, message=None):
-    """Override ArgumentParser's exit() method."""
-    if message:
-      self._print_message(message)
-
-    msgs = self._messages
-    self._messages = []
-    if status == 0:
-      raise ParserNormalExit(msgs=msgs)
-    else:
-      raise ParserError(msgs=msgs)
+    """Customized ArgumentParser for LLM Magics.
+
+    This class overrides the parent argparse.ArgumentParser's error-handling
+    methods to avoid side-effects like printing to stderr. The messages are
+    accumulated and passed into the raised exceptions for the caller to
+    handle them.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._messages: list[str] = []
+
+    def _print_message(self, message, file=None):
+        """Override ArgumentParser's _print_message() method."""
+        del file
+        self._messages.append(message)
+
+    def exit(self, status=0, message=None):
+        """Override ArgumentParser's exit() method."""
+        if message:
+            self._print_message(message)
+
+        msgs = self._messages
+        self._messages = []
+        if status == 0:
+            raise ParserNormalExit(msgs=msgs)
+        else:
+            raise ParserError(msgs=msgs)

google/generativeai/notebook/argument_parser_test.py

@@ -21,38 +21,35 @@
 
 
 class ArgumentParserTest(absltest.TestCase):
+    def test_help(self):
+        """Verify that help messages raise ParserNormalExit."""
+        parser = parser_lib.ArgumentParser()
+        with self.assertRaisesRegex(
+            parser_lib.ParserNormalExit, "show this help message and exit"
+        ):
+            parser.parse_args(["-h"])
 
-  def test_help(self):
-    """Verify that help messages raise ParserNormalExit."""
-    parser = parser_lib.ArgumentParser()
-    with self.assertRaisesRegex(
-        parser_lib.ParserNormalExit, "show this help message and exit"
-    ):
-      parser.parse_args(["-h"])
+    def test_parse_arg_errors(self):
+        def new_parser() -> argparse.ArgumentParser:
+            parser = parser_lib.ArgumentParser()
+            parser.add_argument("--value", type=int, required=True)
+            return parser
 
-  def test_parse_arg_errors(self):
-    def new_parser() -> argparse.ArgumentParser:
-      parser = parser_lib.ArgumentParser()
-      parser.add_argument("--value", type=int, required=True)
-      return parser
+        # Normal case: no error.
+        results = new_parser().parse_args(["--value", "42"])
+        self.assertEqual(42, results.value)
 
-    # Normal case: no error.
-    results = new_parser().parse_args(["--value", "42"])
-    self.assertEqual(42, results.value)
+        with self.assertRaisesRegex(parser_lib.ParserError, "invalid int value"):
+            new_parser().parse_args(["--value", "forty-two"])
 
-    with self.assertRaisesRegex(parser_lib.ParserError, "invalid int value"):
-      new_parser().parse_args(["--value", "forty-two"])
+        with self.assertRaisesRegex(
+            parser_lib.ParserError, "the following arguments are required"
+        ):
+            new_parser().parse_args([])
 
-    with self.assertRaisesRegex(
-        parser_lib.ParserError, "the following arguments are required"
-    ):
-      new_parser().parse_args([])
-
-    with self.assertRaisesRegex(
-        parser_lib.ParserError, "expected one argument"
-    ):
-      new_parser().parse_args(["--value"])
+        with self.assertRaisesRegex(parser_lib.ParserError, "expected one argument"):
+            new_parser().parse_args(["--value"])
 
 
 if __name__ == "__main__":
-  absltest.main()
+    absltest.main()