geniespec 0.1.1__py3-none-any.whl

geniespec/api_schema.yaml

@@ -0,0 +1,372 @@
+$schema: 'http://json-schema.org/draft-07/schema#'
+$id: kibaRestApiSchema
+type: object
+additionalProperties: false
+required:
+  - version
+  - serviceName
+  - pythonClientPackageName
+  - typescriptClientPackageName
+properties:
+  version:
+    type: string
+    pattern: '^([0-9]|[1-9][0-9]*)\.([0-9]|[1-9][0-9]*)\.([0-9]|[1-9][0-9]*)$'
+  serviceName:
+    type: string
+    pattern: '^[a-z][a-z-]*$'
+  pythonClientPackageName:
+    type: string
+    pattern: '^[a-z][-a-z]*$'
+  typescriptClientPackageName:
+    type: string
+    pattern: '[@/-a-z]*$'
+  transitions:
+    type: array
+    items:
+      $ref: '#/definitions/RootTransition'
+  resources:
+    type: array
+    items:
+      $ref: '#/definitions/Resource'
+  exceptions:
+    type: array
+    items:
+      $ref: '#/definitions/Exception'
+  enums:
+    type: array
+    items:
+      $ref: '#/definitions/Enum'
+  oneOfs:
+    type: array
+    items:
+      $ref: '#/definitions/OneOf'
+  imports:
+    type: array
+    items:
+      type: string
+  defaultAuthentication:
+    type:
+      - "null"
+      - string
+    pattern: '^[a-z][a-z0-9-]*$'
+definitions:
+  EnumValues:
+    type: array
+    minItems: 1
+    uniqueItems: true
+    items:
+      type: string
+      pattern: '^[A-Za-z0-9][A-Za-z0-9_-]*$'
+  Enum:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+      - values
+    properties:
+      name:
+        type: string
+        pattern: '^[A-Z][A-Za-z]*$'
+      values:
+        $ref: '#/definitions/EnumValues'
+  OneOf:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+      - discriminator
+      - types
+    properties:
+      name:
+        type: string
+        pattern: '^[A-Z][A-Za-z]*$'
+      discriminator:
+        type: string
+        pattern: '^[a-z][A-Za-z0-9-]*$'
+      types:
+        type: array
+        minItems: 2
+        uniqueItems: true
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-]*$'
+  Attribute:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+      - type
+    properties:
+      name:
+        type: string
+        pattern: '^[a-z][A-Za-z0-9-]*$'
+      type:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      listValueTypes:
+        type: array
+        minItems: 1
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      isPrimary:
+        type: boolean
+      isUnique:
+        type: boolean
+      shouldDisableGetEndpoint:
+        type: boolean
+      isUnfilterable:
+        type: boolean
+      isUpdatable:
+        type: boolean
+      isNullable:
+        type: boolean
+      isDeprecated:
+        type: boolean
+      defaultValue:
+        type:
+          - string
+          - number
+          - boolean
+          - 'null'
+      isSettable:
+        type: boolean
+      isAccessibleIndependently:
+        type: boolean
+      mappingKeyType:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      mappingValueTypes:
+        type: array
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      enumValues:
+        $ref: '#/definitions/EnumValues'
+  Resource:
+    type: object
+    additionalProperties: false
+    required:
+      - singleName
+      - collectionName
+    properties:
+      singleName:
+        type: string
+        pattern: '^[A-Z][A-Za-z-]*$'
+      collectionName:
+        type: string
+        pattern: '^[A-Z][A-Za-z-]*$'
+      parentResource:
+        type: string
+        pattern: '^[A-Z][A-Za-z-]*$'
+      attributes:
+        type: array
+        items:
+          $ref: '#/definitions/Attribute'
+      transitions:
+        type: array
+        items:
+          $ref: '#/definitions/Transition'
+      accessibleFrom:
+        type: array
+        items:
+          type: string
+  BaseTransition:
+    type: object
+    additionalProperties: false
+    required:
+      - action
+    properties:
+      action:
+        type: string
+        pattern: '^[A-Z][A-Z-]*$'
+      method:
+        type: string
+        enum:
+          - GET
+          - POST
+      requestFields:
+        type: array
+        items:
+          $ref: '#/definitions/RequestField'
+      responseField:
+        $ref: '#/definitions/ResponseField'
+      authentication:
+        type:
+          - "null"
+          - string
+        pattern: '^[a-z][a-z0-9-]*$'
+      responseType:
+        type: string
+        enum:
+          - json
+          - stream
+          - redirect
+  Transition:
+    type: object
+    additionalProperties: false
+    required:
+      - action
+    properties:
+      action:
+        type: string
+        pattern: '^[A-Z][A-Z-]*$'
+      method:
+        type: string
+        enum:
+          - GET
+          - POST
+      requestFields:
+        type: array
+        items:
+          $ref: '#/definitions/RequestField'
+      responseField:
+        $ref: '#/definitions/ResponseField'
+      authentication:
+        type:
+          - "null"
+          - string
+        pattern: '^[a-z][a-z0-9-]*$'
+      responseType:
+        type: string
+        enum:
+          - json
+          - stream
+          - redirect
+      operatesOn:
+        type: string
+        enum:
+          - individual
+          - collection
+      isIndirectAction:
+        type: boolean
+  RootTransition:
+    type: object
+    allOf:
+      - $ref: '#/definitions/BaseTransition'
+  RequestField:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+      - type
+    properties:
+      name:
+        type: string
+        pattern: '^[a-z][A-Za-z0-9-]*$'
+      type:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      listValueTypes:
+        type: array
+        minItems: 1
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      mappingKeyType:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      mappingValueTypes:
+        type: array
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      enumValues:
+        $ref: '#/definitions/EnumValues'
+      isRequired:
+        type: boolean
+      defaultValue:
+        type:
+          - string
+          - number
+          - boolean
+          - 'null'
+      isDeprecated:
+        type: boolean
+      maxValue:
+        type:
+          - string
+          - number
+      minValue:
+        type:
+          - string
+          - number
+      source:
+        type: string
+        enum:
+          - request
+          - query-parameters
+  ResponseField:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+      - type
+    properties:
+      name:
+        type: string
+        pattern: '^[a-z][A-Za-z-]*$'
+      type:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      listValueTypes:
+        type: array
+        minItems: 1
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      mappingKeyType:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      mappingValueTypes:
+        type: array
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      enumValues:
+        $ref: '#/definitions/EnumValues'
+      isNullable:
+        type: boolean
+      isList:
+        type: boolean
+  Exception:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+    properties:
+      name:
+        type: string
+        pattern: '^[A-Z][A-Za-z-]*Exception$'
+      message:
+        type: string
+      extends:
+        type: string
+        pattern: '^([a-z-]+.exceptions.[A-Za-z-]*)|([A-Za-z-]*)'
+      statusCode:
+        type: integer
+      fields:
+        type: array
+        items:
+          $ref: '#/definitions/ExceptionField'
+  ExceptionField:
+    type: object
+    additionalProperties: false
+    required:
+      - name
+      - type
+    properties:
+      name:
+        type: string
+        pattern: '^[a-z][A-Za-z-]*$'
+      type:
+        type: string
+        pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      listValueTypes:
+        type: array
+        minItems: 1
+        items:
+          type: string
+          pattern: '^[A-Z][A-Za-z-\[\]_, ]*$'
+      isRequired:
+        type: boolean

geniespec/cli.py

@@ -0,0 +1,123 @@
+import argparse
+import pathlib
+import signal
+import subprocess
+import sys
+import tempfile
+import time
+import types
+
+import yaml  # type: ignore[import-untyped]
+from core import logging
+
+from geniespec.genie import TARGET_LANGUAGE_CODES
+from geniespec.genie import Renderer
+from geniespec.genie import SyntacticApiValidator
+from geniespec.types import KibaApi
+
+WATCH_INTERVAL_SECONDS = 0.5
+COMMAND_STOP_TIMEOUT_SECONDS = 10
+
+
+def _sync_directory(sourceDirectoryPath: pathlib.Path, targetDirectoryPath: pathlib.Path) -> list[pathlib.Path]:
+    changedPaths: list[pathlib.Path] = []
+    sourceRelativePaths = {path.relative_to(sourceDirectoryPath) for path in sourceDirectoryPath.rglob('*') if path.is_file()}
+    for relativePath in sorted(sourceRelativePaths):
+        content = (sourceDirectoryPath / relativePath).read_bytes()
+        targetPath = targetDirectoryPath / relativePath
+        if targetPath.is_file() and targetPath.read_bytes() == content:
+            continue
+        targetPath.parent.mkdir(parents=True, exist_ok=True)
+        temporaryPath = targetPath.with_name(f'.{targetPath.name}.tmp')
+        temporaryPath.write_bytes(content)
+        temporaryPath.replace(targetPath)
+        changedPaths.append(targetPath)
+    stalePaths = [path for path in targetDirectoryPath.rglob('*') if path.is_file() and '__pycache__' not in path.parts and path.relative_to(targetDirectoryPath) not in sourceRelativePaths]
+    for stalePath in stalePaths:
+        stalePath.unlink()
+    return changedPaths + stalePaths
+
+
+def build(specPath: pathlib.Path, target: str, outputDirectoryPath: pathlib.Path) -> list[pathlib.Path]:
+    with open(specPath) as specFile:
+        apiYaml = yaml.safe_load(specFile)
+    SyntacticApiValidator().validate(apiYaml)
+    api = KibaApi(**apiYaml)
+    with tempfile.TemporaryDirectory() as renderDirectory:
+        Renderer(target=target).render_directory(api=api, outputDirectoryPath=renderDirectory)
+        changedPaths: list[pathlib.Path] = []
+        # NOTE(krishan711): only sync the packages the target generates so other files in the output directory are never touched
+        for packagePath in sorted(pathlib.Path(renderDirectory).iterdir()):
+            changedPaths += _sync_directory(sourceDirectoryPath=packagePath, targetDirectoryPath=outputDirectoryPath / packagePath.name)
+        return changedPaths
+
+
+def _build_and_log(specPath: pathlib.Path, target: str, outputDirectoryPath: pathlib.Path) -> None:
+    changedPaths = build(specPath=specPath, target=target, outputDirectoryPath=outputDirectoryPath)
+    logging.info(f'geniespec: built {specPath} into {outputDirectoryPath} ({len(changedPaths)} files changed)')
+
+
+def _stop_process(process: subprocess.Popen[bytes]) -> None:
+    if process.poll() is not None:
+        return
+    process.terminate()
+    try:
+        process.wait(timeout=COMMAND_STOP_TIMEOUT_SECONDS)
+    except subprocess.TimeoutExpired:
+        process.kill()
+        process.wait()
+
+
+def watch(specPath: pathlib.Path, target: str, outputDirectoryPath: pathlib.Path, command: list[str]) -> int:
+    lastModifiedTime: int | None = None
+    process: subprocess.Popen[bytes] | None = None
+    try:
+        while True:
+            try:
+                modifiedTime: int | None = specPath.stat().st_mtime_ns
+            except FileNotFoundError:
+                modifiedTime = lastModifiedTime
+            if modifiedTime != lastModifiedTime:
+                lastModifiedTime = modifiedTime
+                try:
+                    _build_and_log(specPath=specPath, target=target, outputDirectoryPath=outputDirectoryPath)
+                except Exception as exception:  # noqa: BLE001
+                    logging.error(f'geniespec: failed to build {specPath}, keeping the previous output: {exception}')
+            if command and process is None:
+                process = subprocess.Popen(command)  # noqa: S603
+            if process is not None and process.poll() is not None:
+                return process.returncode
+            time.sleep(WATCH_INTERVAL_SECONDS)
+    finally:
+        if process is not None:
+            _stop_process(process=process)
+
+
+def _exit_on_terminate(signalNumber: int, frame: types.FrameType | None) -> None:  # noqa: ARG001
+    sys.exit(128 + signalNumber)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(prog='geniespec')
+    subparsers = parser.add_subparsers(dest='subcommand', required=True)
+    for subcommand in ('build', 'watch'):
+        subparser = subparsers.add_parser(subcommand)
+        subparser.add_argument('--spec', type=pathlib.Path, required=True)
+        subparser.add_argument('--target', choices=sorted(TARGET_LANGUAGE_CODES), required=True)
+        subparser.add_argument('--output', type=pathlib.Path, default=pathlib.Path())
+    subparsers.choices['watch'].add_argument('command', nargs=argparse.REMAINDER, help='command to run while watching, after --')
+    args = parser.parse_args()
+    logging.basicConfig(level=logging.INFO)
+    if args.subcommand == 'build':
+        _build_and_log(specPath=args.spec, target=args.target, outputDirectoryPath=args.output)
+        return
+    command = args.command[1:] if args.command[:1] == ['--'] else args.command
+    signal.signal(signal.SIGTERM, _exit_on_terminate)
+    try:
+        sys.exit(watch(specPath=args.spec, target=args.target, outputDirectoryPath=args.output, command=command))
+    except KeyboardInterrupt:
+        return
+
+
+if __name__ == '__main__':
+    main()