Skip to content

Commit

Permalink
fix: pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
clatapie committed Mar 19, 2024
1 parent 2bc93dc commit 1b1c3c0
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 5 deletions.
13 changes: 9 additions & 4 deletions src/pyconverter/xml2py/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@
import os

import click
from pyconverter.xml2py import (__version__, download, writer, formatter)
from pyconverter.xml2py import __version__, download, formatter, writer



def create_package(xml_path=None, functions_path=None, target_path=None, template_path=None, max_docstring_length=100):
def create_package(
xml_path=None,
functions_path=None,
target_path=None,
template_path=None,
max_docstring_length=100,
):
"""Create Python package based on a XML documentation.
Parameters
Expand Down Expand Up @@ -93,7 +98,7 @@ def create_package(xml_path=None, functions_path=None, target_path=None, templat
package_path = os.path.join(target_path, "package")
writer.write_docs(commands, cmd_map, package_path)
formatter.run_black(package_path, max_docstring_length)


@click.group()
def main():
Expand Down
24 changes: 23 additions & 1 deletion src/pyconverter/xml2py/formatter.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
#
# 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.

"""This module contains the functions to format the generated docstrings with
`Black <black_>`_."""


def run_black(package_path, max_docstring_length):
"""Run `Black <black_>`_ on the autogenerated package."""
exec(f"black {package_path}/src/pyconverter/generatedcommands -l {max_docstring_length}")
exec(f"black {package_path}/src/pyconverter/generatedcommands -l {max_docstring_length}")

0 comments on commit 1b1c3c0

Please sign in to comment.