kiba-build 0.1.11.dev1__tar.gz

kiba_build-0.1.11.dev1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.2
+Name: kiba-build
+Version: 0.1.11.dev1
+Summary: Kiba Labs' python building and testing utilities
+Requires-Python: ~=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: asyncclick~=8.1.8
+Requires-Dist: bandit~=1.8.3
+Requires-Dist: bump-my-version>=0.29.0
+Requires-Dist: click~=8.1.7
+Requires-Dist: mypy~=1.15.0
+Requires-Dist: pylint~=3.3.4
+Requires-Dist: simple-chalk~=0.1.0
+Requires-Dist: twine~=6.1.0
+Requires-Dist: wheel~=0.45.1
+
+# Build-Py

kiba_build-0.1.11.dev1/README.md

@@ -0,0 +1 @@
+# Build-Py

kiba_build-0.1.11.dev1/buildpy/lint_check.py

@@ -0,0 +1,61 @@
+import os
+from typing import List
+
+import click
+from pylint.lint import Run as run_pylint
+from pylint.reporters import CollectingReporter
+
+from buildpy.util import GitHubAnnotationsReporter
+from buildpy.util import Message
+from buildpy.util import MessageParser
+from buildpy.util import PrettyReporter
+
+
+class PylintMessageParser(CollectingReporter, MessageParser):
+
+    @staticmethod
+    def _get_error_level(pylintLevel: str) -> str:
+        pylintLevel = pylintLevel.lower()
+        if pylintLevel == 'info':
+            return 'notice'
+        if pylintLevel == 'warning':
+            return 'warning'
+        return 'error'
+
+    def parse_messages(self, rawMessages: List[str]) -> List[Message]:
+        raise NotImplementedError
+
+    def get_messages(self) -> List[Message]:
+        output: List[Message] = []
+        for rawMessage in self.messages:
+            output.append(Message(
+                path=os.path.relpath(rawMessage.abspath),
+                line=rawMessage.line,
+                column=rawMessage.column + 1,
+                code=rawMessage.symbol,
+                text=rawMessage.msg.strip() or '',
+                level=self._get_error_level(pylintLevel=rawMessage.category),
+            ))
+        return output
+
+
+@click.command()
+@click.argument('targets', nargs=-1)
+@click.option('-o', '--output-file', 'outputFilename', required=False, type=str)
+@click.option('-f', '--output-format', 'outputFormat', required=False, type=str, default='pretty')
+@click.option('-c', '--config-file-path', 'configFilePath', required=False, type=str)
+def run(targets: List[str], outputFilename: str, outputFormat: str, configFilePath: str) -> None:
+    currentDirectory = os.path.dirname(os.path.realpath(__file__))
+    pylintConfigFilePath = configFilePath or f'{currentDirectory}/pyproject.toml'
+    pylintMessageParser = PylintMessageParser()
+    run_pylint([f'--rcfile={pylintConfigFilePath}', f'--jobs=0'] + list(targets), reporter=pylintMessageParser, exit=False)
+    reporter = GitHubAnnotationsReporter() if outputFormat == 'annotations' else PrettyReporter()
+    output = reporter.create_output(messages=pylintMessageParser.get_messages())
+    if outputFilename:
+        with open(outputFilename, 'w') as outputFile:
+            outputFile.write(output)
+    else:
+        print(output)
+
+if __name__ == '__main__':
+    run()  # pylint: disable=no-value-for-parameter

kiba_build-0.1.11.dev1/buildpy/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561 (https://www.python.org/dev/peps/pep-0561/). This package uses inline types.

kiba_build-0.1.11.dev1/buildpy/security_check.py

@@ -0,0 +1,156 @@
+import os
+import subprocess
+from typing import List
+
+import click
+
+from buildpy.util import GitHubAnnotationsReporter
+from buildpy.util import Message
+from buildpy.util import MessageParser
+from buildpy.util import PrettyReporter
+
+# TODO(krishan711): remove this once test_name is enabled https://github.com/PyCQA/bandit/issues/962
+BANDIT_CODES = {
+    'B101': 'assert_used',
+    'B102': 'exec_used',
+    'B103': 'set_bad_file_permissions',
+    'B104': 'hardcoded_bind_all_interfaces',
+    'B105': 'hardcoded_password_string',
+    'B106': 'hardcoded_password_funcarg',
+    'B107': 'hardcoded_password_default',
+    'B108': 'hardcoded_tmp_directory',
+    'B110': 'try_except_pass',
+    'B112': 'try_except_continue',
+    'B201': 'flask_debug_true',
+    'B301': 'pickle',
+    'B302': 'marshal',
+    'B303': 'md5',
+    'B304': 'ciphers',
+    'B305': 'cipher_modes',
+    'B306': 'mktemp_q',
+    'B307': 'eval',
+    'B308': 'mark_safe',
+    'B309': 'httpsconnection',
+    'B310': 'urllib_urlopen',
+    'B311': 'random',
+    'B312': 'telnetlib',
+    'B313': 'xml_bad_cElementTree',
+    'B314': 'xml_bad_ElementTree',
+    'B315': 'xml_bad_expatreader',
+    'B316': 'xml_bad_expatbuilder',
+    'B317': 'xml_bad_sax',
+    'B318': 'xml_bad_minidom',
+    'B319': 'xml_bad_pulldom',
+    'B320': 'xml_bad_etree',
+    'B321': 'ftplib',
+    'B323': 'unverified_context',
+    'B324': 'hashlib_insecure_functions',
+    'B325': 'tempnam',
+    'B401': 'import_telnetlib',
+    'B402': 'import_ftplib',
+    'B403': 'import_pickle',
+    'B404': 'import_subprocess',
+    'B405': 'import_xml_etree',
+    'B406': 'import_xml_sax',
+    'B407': 'import_xml_expat',
+    'B408': 'import_xml_minidom',
+    'B409': 'import_xml_pulldom',
+    'B410': 'import_lxml',
+    'B411': 'import_xmlrpclib',
+    'B412': 'import_httpoxy',
+    'B413': 'import_pycrypto',
+    'B415': 'import_pyghmi',
+    'B501': 'request_with_no_cert_validation',
+    'B502': 'ssl_with_bad_version',
+    'B503': 'ssl_with_bad_defaults',
+    'B504': 'ssl_with_no_version',
+    'B505': 'weak_cryptographic_key',
+    'B506': 'yaml_load',
+    'B507': 'ssh_no_host_key_verification',
+    'B508': 'snmp_insecure_version',
+    'B509': 'snmp_weak_cryptography',
+    'B601': 'paramiko_calls',
+    'B602': 'subprocess_popen_with_shell_equals_true',
+    'B603': 'subprocess_without_shell_equals_true',
+    'B604': 'any_other_function_with_shell_equals_true',
+    'B605': 'start_process_with_a_shell',
+    'B606': 'start_process_with_no_shell',
+    'B607': 'start_process_with_partial_path',
+    'B608': 'hardcoded_sql_expressions',
+    'B609': 'linux_commands_wildcard_injection',
+    'B610': 'django_extra_used',
+    'B611': 'django_rawsql_used',
+    'B701': 'jinja2_autoescape_false',
+    'B702': 'use_of_mako_templates',
+    'B703': 'django_mark_safe',
+}
+
+class BanditMessageParser(MessageParser):
+
+    @staticmethod
+    def _get_error_level(banditLevel: str) -> str:
+        banditLevel = banditLevel.lower()
+        if banditLevel == 'low':
+            return 'notice'
+        if banditLevel == 'warning':
+            return 'warning'
+        return 'error'
+
+    def parse_messages(self, rawMessages: List[str]) -> List[Message]:
+        output: List[Message] = []
+        for rawMessage in rawMessages:
+            rawMessage = rawMessage.strip()
+            if len(rawMessage) == 0 or rawMessage.startswith('filename,test_name,'):
+                continue
+            print(rawMessage)
+            rawMessageParts = rawMessage.split('\t')
+            if len(rawMessageParts) == 1:
+                continue
+            if rawMessageParts[0] == '[tester]':
+                output.append(Message(
+                    path='',
+                    line=0,
+                    column=0,
+                    code='tester',
+                    text=rawMessageParts[2],
+                    level=self._get_error_level(banditLevel=rawMessageParts[1]),
+                ))
+            else:
+                output.append(Message(
+                    path=rawMessageParts[0],
+                    line=int(rawMessageParts[1]),
+                    column=int(rawMessageParts[2]),
+                    code=BANDIT_CODES[rawMessageParts[3]],
+                    text=rawMessageParts[4],
+                    level=self._get_error_level(banditLevel=rawMessageParts[5]),
+                ))
+        return output
+
+
+@click.command()
+@click.argument('targets', nargs=-1)
+@click.option('-o', '--output-file', 'outputFilename', required=False, type=str)
+@click.option('-f', '--output-format', 'outputFormat', required=False, type=str, default='pretty')
+@click.option('-c', '--config-file-path', 'configFilePath', required=False, type=str)
+def run(targets: List[str], outputFilename: str, outputFormat: str, configFilePath: str) -> None:
+    currentDirectory = os.path.dirname(os.path.realpath(__file__))
+    messages: List[str] = []
+    banditConfigFilePath = configFilePath or f'{currentDirectory}/pyproject.toml'
+    # TODO(krishan711): use test_name here once enabled https://github.com/PyCQA/bandit/issues/962
+    messageTemplate = '{abspath}\t{line}\t{col}\t{test_id}\t{msg}\t{severity}'
+    try:
+        subprocess.check_output(f'bandit --configfile {banditConfigFilePath} --silent --severity-level medium --confidence-level medium --format custom --msg-template \"{messageTemplate}\" --recursive {" ".join(targets)}', stderr=subprocess.STDOUT, shell=True)  # nosec=subprocess_popen_with_shell_equals_true
+    except subprocess.CalledProcessError as exception:
+        messages = exception.output.decode().split('\n')
+    messageParser = BanditMessageParser()
+    parsedMessages = messageParser.parse_messages(rawMessages=messages)
+    reporter = GitHubAnnotationsReporter() if outputFormat == 'annotations' else PrettyReporter()
+    output = reporter.create_output(messages=parsedMessages)
+    if outputFilename:
+        with open(outputFilename, 'w') as outputFile:
+            outputFile.write(output)
+    else:
+        print(output)
+
+if __name__ == '__main__':
+    run()  # pylint: disable=no-value-for-parameter

kiba_build-0.1.11.dev1/buildpy/type_check.py

@@ -0,0 +1,67 @@
+import os
+import re
+import subprocess
+from typing import List
+
+import click
+
+from buildpy.util import GitHubAnnotationsReporter
+from buildpy.util import Message
+from buildpy.util import MessageParser
+from buildpy.util import PrettyReporter
+
+
+class MypyMessageParser(MessageParser):
+
+    def parse_messages(self, rawMessages: List[str]) -> List[Message]:
+        output: List[Message] = []
+        for rawMessage in rawMessages:
+            rawMessage = rawMessage.strip()
+            if len(rawMessage) == 0 \
+                or ' note: ' in rawMessage \
+                or 'Use "-> None" if function does not return a value' in rawMessage:
+                continue
+            if 'Error importing plugin "pydantic.mypy":' in rawMessage:
+                # NOTE(krishan711): we use pydantic rules but it may not be installed (like in this repo)
+                continue
+            match1 = re.match(r'(.*):(\d*):(\d*): (.*): (.*) \[(.*)\]', rawMessage)
+            match2 = None
+            if not match1:
+                # match2 = match1 without column number
+                match2 = re.match(r'(.*):(\d*): (.*): (.*) \[(.*)\]', rawMessage)
+            output.append(Message(
+                path=match1.group(1) if match1 else (match2.group(1) if match2 else ''),
+                line=int(match1.group(2)) if match1 else (int(match2.group(2)) if match2 else 0),
+                column=int(match1.group(3)) if match1 else (0 if match2 else 0),
+                code=match1.group(6) if match1 else (match2.group(5) if match2 else 'unparsed'),
+                text=match1.group(5).strip() if match1 else (match2.group(4).strip() if match2 else rawMessage.strip()),
+                level=match1.group(4) if match1 else (match2.group(3) if match2 else 'error'),
+            ))
+        return output
+
+
+@click.command()
+@click.argument('targets', nargs=-1)
+@click.option('-o', '--output-file', 'outputFilename', required=False, type=str)
+@click.option('-f', '--output-format', 'outputFormat', required=False, type=str, default='pretty')
+@click.option('-c', '--config-file-path', 'configFilePath', required=False, type=str)
+def run(targets: List[str], outputFilename: str, outputFormat: str, configFilePath: str) -> None:
+    currentDirectory = os.path.dirname(os.path.realpath(__file__))
+    mypyConfigFilePath = configFilePath or f'{currentDirectory}/pyproject.toml'
+    messages: List[str] = []
+    try:
+        subprocess.check_output(f'mypy {" ".join(targets)} --config-file {mypyConfigFilePath} --no-color-output --hide-error-context --no-pretty --no-error-summary --show-error-codes --show-column-numbers', stderr=subprocess.STDOUT, shell=True)  # nosec=subprocess_popen_with_shell_equals_true
+    except subprocess.CalledProcessError as exception:
+        messages = exception.output.decode().split('\n')
+    messageParser = MypyMessageParser()
+    parsedMessages = messageParser.parse_messages(rawMessages=messages)
+    reporter = GitHubAnnotationsReporter() if outputFormat == 'annotations' else PrettyReporter()
+    output = reporter.create_output(messages=parsedMessages)
+    if outputFilename:
+        with open(outputFilename, 'w') as outputFile:
+            outputFile.write(output)
+    else:
+        print(output)
+
+if __name__ == '__main__':
+    run()  # pylint: disable=no-value-for-parameter

kiba_build-0.1.11.dev1/buildpy/util.py

@@ -0,0 +1,83 @@
+import dataclasses
+import json
+import os
+from collections import defaultdict
+from typing import List
+
+from simple_chalk import chalk  # type: ignore
+
+
+@dataclasses.dataclass
+class Message:
+    path: str
+    line: int
+    column: int
+    code: str
+    text: str
+    level: str # (error, warning, notice)
+
+
+class MessageParser:
+
+    def parse_messages(self, rawMessages: List[str]) -> List[Message]:
+        raise NotImplementedError
+
+
+class KibaReporter:
+
+    def create_output(self, messages: List[Message]) -> str:
+        raise NotImplementedError
+
+
+class GitHubAnnotationsReporter(KibaReporter):
+
+    def create_output(self, messages: List[Message]) -> str:
+        annotations = []
+        for message in messages:
+            annotation = {
+                'path': os.path.relpath(message.path) if message.path else '<unknown>',
+                'start_line': message.line,
+                'end_line': message.line,
+                'start_column': message.column,
+                'end_column': message.column,
+                'message': f'[{message.code}] {message.text}',
+                'annotation_level': 'notice' if message.level == 'notice' else ('warning' if message.level == 'warning' else 'failure'),
+            }
+            annotations.append(annotation)
+        return json.dumps(annotations)
+
+
+class PrettyReporter(KibaReporter):
+
+    @staticmethod
+    def get_summary(errorCount: int, warningCount: int) -> str:
+        summary = ''
+        if errorCount:
+            summary += chalk.red(f'{errorCount} errors')
+        if warningCount:
+            summary = f'{summary} and ' if summary else ''
+            summary += chalk.yellow(f'{warningCount} warnings')
+        return summary
+
+    def create_output(self, messages: List[Message]) -> str:
+        fileMessageMap = defaultdict(list)
+        for message in messages:
+            fileMessageMap[os.path.relpath(message.path) if message.path else '<unknown>'].append(message)
+        totalErrorCount = 0
+        totalWarningCount = 0
+        outputs = []
+        for (filePath, fileMessages) in fileMessageMap.items():
+            fileOutputs = []
+            for message in fileMessages:
+                location = chalk.grey(f'{filePath}:{message.line}:{message.column}')
+                color = chalk.white if message.level == 'notice' else (chalk.yellow if message.level == 'warning' else chalk.red)
+                fileOutputs.append(f'{location} [{color(message.code)}] {message.text}')
+            errorCount = sum(1 for message in fileMessages if message.level == 'error')
+            totalErrorCount += errorCount
+            warningCount = sum(1 for message in fileMessages if message.level == 'warning')
+            totalWarningCount += warningCount
+            fileOutputString = '\n'.join(fileOutputs)
+            outputs.append(f'{self.get_summary(errorCount, warningCount)} in {filePath}\n{fileOutputString}\n')
+        output = '\n'.join(outputs)
+        output += f'\nFailed due to {self.get_summary(totalErrorCount, totalWarningCount)}.' if (totalErrorCount or totalWarningCount) else chalk.green('Passed.')
+        return output

kiba_build-0.1.11.dev1/buildpy/version.py

@@ -0,0 +1,29 @@
+import importlib.metadata
+import subprocess
+import tomllib
+
+import click
+
+
+def generate_command(part: str) -> str:
+    with open('pyproject.toml', 'r') as file:
+        pyproject = tomllib.loads(file.read())
+    currentVersion = pyproject['project']['version']
+    return f"bump-my-version bump --allow-dirty --current-version \"{currentVersion}\" --parse '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\.dev(?P<dev>\\d+))?' --serialize '{{major}}.{{minor}}.{{patch}}.dev{{dev}}' --serialize '{{major}}.{{minor}}.{{patch}}' {part} pyproject.toml"
+
+@click.command()
+@click.option('-p', '--part', 'part', required=True, type=str)
+@click.option('-c', '--count', 'count', required=False, type=int, default=1)
+def run(part: str, count: int) -> None:
+    print('here', part, count)
+    if count == 0:
+        print('No version bump required')
+        return
+    # NOTE(krishan711): for dev releases bump the patch first
+    if part == 'dev':
+        subprocess.check_output(generate_command(part='patch'), stderr=subprocess.STDOUT, shell=True)  # nosec=subprocess_popen_with_shell_equals_true
+    for _ in range(count):
+        subprocess.check_output(generate_command(part=part), stderr=subprocess.STDOUT, shell=True)  # nosec=subprocess_popen_with_shell_equals_true
+
+if __name__ == '__main__':
+    run()  # pylint: disable=no-value-for-parameter

kiba_build-0.1.11.dev1/kiba_build.egg-info/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.2
+Name: kiba-build
+Version: 0.1.11.dev1
+Summary: Kiba Labs' python building and testing utilities
+Requires-Python: ~=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: asyncclick~=8.1.8
+Requires-Dist: bandit~=1.8.3
+Requires-Dist: bump-my-version>=0.29.0
+Requires-Dist: click~=8.1.7
+Requires-Dist: mypy~=1.15.0
+Requires-Dist: pylint~=3.3.4
+Requires-Dist: simple-chalk~=0.1.0
+Requires-Dist: twine~=6.1.0
+Requires-Dist: wheel~=0.45.1
+
+# Build-Py

kiba_build-0.1.11.dev1/kiba_build.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+buildpy/__init__.py
+buildpy/lint_check.py
+buildpy/py.typed
+buildpy/security_check.py
+buildpy/type_check.py
+buildpy/util.py
+buildpy/version.py
+kiba_build.egg-info/PKG-INFO
+kiba_build.egg-info/SOURCES.txt
+kiba_build.egg-info/dependency_links.txt
+kiba_build.egg-info/entry_points.txt
+kiba_build.egg-info/requires.txt
+kiba_build.egg-info/top_level.txt

kiba_build-0.1.11.dev1/kiba_build.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kiba_build-0.1.11.dev1/kiba_build.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+lint-check = buildpy.lint_check:run
+security-check = buildpy.security_check:run
+type-check = buildpy.type_check:run
+version = buildpy.version:run

kiba_build-0.1.11.dev1/kiba_build.egg-info/requires.txt

@@ -0,0 +1,9 @@
+asyncclick~=8.1.8
+bandit~=1.8.3
+bump-my-version>=0.29.0
+click~=8.1.7
+mypy~=1.15.0
+pylint~=3.3.4
+simple-chalk~=0.1.0
+twine~=6.1.0
+wheel~=0.45.1

kiba_build-0.1.11.dev1/kiba_build.egg-info/top_level.txt

@@ -0,0 +1 @@
+buildpy

kiba_build-0.1.11.dev1/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "kiba-build"
+version = "0.1.11.dev1"
+description = "Kiba Labs' python building and testing utilities"
+readme = "README.md"
+requires-python = "~=3.11"
+dependencies = [
+    "asyncclick~=8.1.8",
+    "bandit~=1.8.3",
+    "bump-my-version>=0.29.0",
+    "click~=8.1.7",
+    "mypy~=1.15.0",
+    "pylint~=3.3.4",
+    "simple-chalk~=0.1.0",
+    "twine~=6.1.0",
+    "wheel~=0.45.1",
+]
+
+[project.scripts]
+lint-check = "buildpy.lint_check:run"
+type-check = "buildpy.type_check:run"
+security-check = "buildpy.security_check:run"
+version = "buildpy.version:run"
+
+[tool.uv]
+package = true

kiba_build-0.1.11.dev1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+