Merge pull request #92 from csdms/mcflugen/remove-prettier

Remove black and isort dependencies

Author: mcflugen

.pre-commit-config.yaml

@@ -66,17 +66,6 @@ repos:
     - id: forbid-new-submodules
     - id: trailing-whitespace
 
-- repo: https://github.com/PyCQA/pydocstyle
-  rev: 6.3.0
-  hooks:
-  - id: pydocstyle
-    files: babelizer/.*\.py$
-    args:
-    - --convention=numpy
-    - --add-select=D417
-    exclude: ^babelizer/data
-    additional_dependencies: [".[toml]"]
-
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: v1.8.0
   hooks:

README.rst

@@ -94,7 +94,7 @@ Read all about them in the `Basic Model Interface`_ documentation.
 Requirements
 ------------
 
-The *babelizer* requires Python >=3.9.
+The *babelizer* requires Python >=3.10.
 
 
 Apart from Python, the *babelizer* has a number of other requirements, all of which
@@ -396,23 +396,13 @@ called *hydrotrend*.
     python_version = ["3.7", "3.8", "3.9"]
     os = ["linux", "mac", "windows"]
 
-You can use the ``babelize generate`` command to generate *babel.toml* files.
-For example the above *babel.toml* can be generated with the following,
+You can use the ``babelize sample-config`` command to generate
+a sample *babel.toml* file to get you started. For example,
+the above *babel.toml* can be generated with the following,
 
 .. code:: bash
 
-    $ babelize generate \
-	  --package=pymt_hydrotrend \
-	  --summary="PyMT plugin for hydrotrend" \
-	  --language=c \
-	  --library=bmi_hydrotrend \
-	  --header=bmi_hydrotrend.h \
-	  --entry-point=register_bmi_hydrotrend \
-	  --name=Hydrotrend \
-	  --requirement=hydrotrend \
-    --os-name=linux,mac,windows \
-    --python-version=3.7,3.8,3.9 > babel.toml
-
+    babelize sample-config
 
 Use
 ---
@@ -422,13 +412,13 @@ sending output to the current directory
 
 .. code:: bash
 
-  $ babelize init babel.toml
+    babelize init babel.toml
 
 Update an existing repository
 
 .. code:: bash
 
-  $ babelize update
+  babelize update
 
 For a complete example of using the *babelizer*
 to wrap a C library exposing a BMI,

babelizer/_datadir.py

@@ -0,0 +1,10 @@
+import sys
+
+if sys.version_info >= (3, 12):  # pragma: no cover (PY12+)
+    import importlib.resources as importlib_resources
+else:  # pragma: no cover (<PY312)
+    import importlib_resources
+
+
+def get_datadir() -> str:
+    return str(importlib_resources.files("babelizer") / "data")

babelizer/_files/bmi_py.py

@@ -0,0 +1,89 @@
+import os
+
+
+def render(plugin_metadata) -> str:
+    """Render _bmi.py."""
+    languages = {
+        library["language"] for library in plugin_metadata._meta["library"].values()
+    }
+    assert len(languages) == 1
+    language = languages.pop()
+
+    if language == "python":
+        return _render_bmi_py(plugin_metadata)
+    else:
+        return _render_bmi_c(plugin_metadata)
+
+
+def _render_bmi_c(plugin_metadata) -> str:
+    """Render _bmi.py for a non-python library."""
+    languages = [
+        library["language"] for library in plugin_metadata._meta["library"].values()
+    ]
+    language = languages[0]
+    assert language in ("c", "c++", "fortran")
+
+    imports = [
+        f"from {plugin_metadata.get('package', 'name')}.lib import {cls}"
+        for cls in plugin_metadata._meta["library"]
+    ]
+
+    names = [
+        f"    {cls!r},".replace("'", '"') for cls in plugin_metadata._meta["library"]
+    ]
+
+    return f"""\
+{os.linesep.join(sorted(imports))}
+
+__all__ = [
+{os.linesep.join(sorted(names))}
+]\
+"""
+
+
+def _render_bmi_py(plugin_metadata) -> str:
+    """Render _bmi.py for a python library."""
+    languages = [
+        library["language"] for library in plugin_metadata._meta["library"].values()
+    ]
+    language = languages[0]
+    assert language == "python"
+
+    header = """\
+import sys
+
+if sys.version_info >= (3, 12):  # pragma: no cover (PY12+)
+    import importlib.resources as importlib_resources
+else:  # pragma: no cover (<PY312)
+    import importlib_resources
+"""
+
+    imports = [
+        f"from {component['library']} import {component['entry_point']} as {cls}"
+        for cls, component in plugin_metadata._meta["library"].items()
+    ]
+
+    rename = [
+        f"""\
+{cls}.__name__ = {cls!r}
+{cls}.METADATA = str(importlib_resources.files(__name__) / "data/{cls}")
+""".replace(
+            "'", '"'
+        )
+        for cls in plugin_metadata._meta["library"]
+    ]
+
+    names = [
+        f"    {cls!r},".replace("'", '"') for cls in plugin_metadata._meta["library"]
+    ]
+
+    return f"""\
+{header}
+{os.linesep.join(sorted(imports))}
+
+{os.linesep.join(sorted(rename))}
+
+__all__ = [
+{os.linesep.join(sorted(names))}
+]\
+"""

babelizer/_files/gitignore.py

@@ -0,0 +1,27 @@
+import os
+
+
+def render(plugin_metadata) -> str:
+    """Render a .gitignore file."""
+    package_name = plugin_metadata["package"]["name"]
+
+    languages = {library["language"] for library in plugin_metadata["library"].values()}
+    ignore = {
+        "*.egg-info/",
+        "*.py[cod]",
+        ".coverage",
+        ".nox/",
+        "__pycache__/",
+        "build/",
+        "dist/",
+    }
+
+    if "python" not in languages:
+        ignore |= {"*.o", "*.so"} | {
+            f"{package_name}/lib/{cls.lower()}.c" for cls in plugin_metadata["library"]
+        }
+
+    if "fortran" in languages:
+        ignore |= {"*.mod", "*.smod"}
+
+    return f"{os.linesep.join(sorted(ignore))}"

babelizer/_files/init_py.py

@@ -0,0 +1,25 @@
+import os
+
+
+def render(plugin_metadata) -> str:
+    """Render __init__.py."""
+    package_name = plugin_metadata.get("package", "name")
+
+    imports = [f"from {package_name}._version import __version__"]
+    imports += [
+        f"from {package_name}._bmi import {cls}"
+        for cls in plugin_metadata._meta["library"]
+    ]
+
+    names = [
+        f"    {cls!r},".replace("'", '"') for cls in plugin_metadata._meta["library"]
+    ]
+
+    return f"""\
+{os.linesep.join(sorted(imports))}
+
+__all__ = [
+    "__version__",
+{os.linesep.join(sorted(names))}
+]\
+"""

babelizer/_files/lib_init_py.py

@@ -0,0 +1,22 @@
+import os
+
+
+def render(plugin_metadata) -> str:
+    """Render lib/__init__.py."""
+    package_name = plugin_metadata.get("package", "name")
+    imports = [
+        f"from {package_name}.lib.{cls.lower()} import {cls}"
+        for cls in plugin_metadata._meta["library"]
+    ]
+
+    names = [
+        f"    {cls!r},".replace("'", '"') for cls in plugin_metadata._meta["library"]
+    ]
+
+    return f"""\
+{os.linesep.join(sorted(imports))}
+
+__all__ = [
+{os.linesep.join(sorted(names))}
+]\
+"""

babelizer/_files/license_rst.py

@@ -0,0 +1,145 @@
+from datetime import datetime
+
+
+def render(plugin_metadata) -> str:
+    """Render LICENSE.rst."""
+    license_name = plugin_metadata["info"]["package_license"]
+    kwds = {
+        "full_name": plugin_metadata["info"]["package_author"],
+        "year": datetime.now().year,
+        "project_short_description": plugin_metadata["info"]["summary"],
+    }
+
+    return LICENSE[license_name].format(**kwds)
+
+
+LICENSE = {
+    "MIT License": """\
+MIT License
+===========
+
+Copyright (c) *{year}*, *{full_name}*
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.\
+""",
+    "BSD License": """\
+BSD License
+===========
+
+Copyright (c) *{year}*, *{full_name}*
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+""",
+    "ISC License": """\
+ISC License
+===========
+
+Copyright (c) *{year}*, *{full_name}*
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.\
+""",
+    "Apache Software License 2.0": """\
+Apache Software License 2.0
+===========================
+
+Copyright (c) *{year}*, *{full_name}*
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.\
+""",
+    "GNU General Public License v3": """\
+GNU GENERAL PUBLIC LICENSE
+==========================
+
+                      Version 3, 29 June 2007
+
+    {project_short_description}
+    Copyright (c) *{year}*, *{full_name}*
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.\
+""",
+}