lua-annotations 0.1.0__tar.gz

lua_annotations-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

lua_annotations-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: lua-annotations
+Version: 0.1.0
+Summary: lua-annotations build-time processor/validator
+Author: pigxity
+License-Expression: Apache-2.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# lua-annotations-python
+
+A lua annotation processor written in python; it's targeted toward Roblox development and is to be used as a modular game framework or simply a build-time processor.
+
+### [Documentation](https://pigxity-games.github.io/lua-annotations)
+
+
+## Key concepts
+### Processor
+- Expandable with an API
+- Allows for functionality during build-time, runtime, or for both.
+
+### Game framework
+- Services (`@service`) define individual game logic
+- Controllers (`@controller`) define per-instance behavior and are automatically mapped to instances containing CollectionService tags
+- Dependency injection for services and controllers with automatic load ordering
+- Seamless networking bridge; simply import "remote services" (wrappers of RemoteEvents/Functions) 
+
+----
+
+
+## CLI usage
+To setup your project, run `lua-anot init path/to/project`. This creates a default config file. Don't forget to change the default environment paths if your project setup differs! 
+
+This is mostly a CLI tool; to build a project, run this command: `lua-anot build path/to/project`. This command assumes the project directory contains a `annotations.config.json` file. You may specify a custom filename using the `--config` or `-c` argument.
+
+The program also has a watch command, which detects changes and automatically rebuilds; used via `lua-anot watch`.
+
+### Multiple workspaces
+A workspace represents one individual place synced with rojo. Multi-place games would require using multiple.
+It is also possible to have multiple paths per ennvironment, if you want to.
+
+## Defining custom annotations
+The program contains an easy API to do so!
+```python
+#Runs after annotation parsing
+class MyExtension(Extension):
+    def on_build_test_anot(ctx: AnnotationBuildCtx):
+        print(f'Hello World, {ctx.annotation.name}!')
+
+    #Runs after all files have been processed
+    def on_post_process(ctx: PostProcessCtx):
+        print('Build finished!')
+
+    def load(ctx: ExtensionRegistry):
+        ctx.register_anot(AnnotationDef('moduleTest', scope='module', on_build=self.on_build_test_anot)
+
+
+def load(ctx: ExtensionRegistry):
+    ctx.register_extension(MyExtension())
+```
+
+add it to your project's config file:
+`annotations.config.json`
+```json
+extensions = [
+    ["path", "my_extension/main.py"]
+]
+```
+
+**Note: see the documentation for more info.**
+
+**Since the project uses this API internally for optional extensions, you may also see the sourcecode under `/src/extensions/` for reference!**

lua_annotations-0.1.0/README.md

@@ -0,0 +1,63 @@
+# lua-annotations-python
+
+A lua annotation processor written in python; it's targeted toward Roblox development and is to be used as a modular game framework or simply a build-time processor.
+
+### [Documentation](https://pigxity-games.github.io/lua-annotations)
+
+
+## Key concepts
+### Processor
+- Expandable with an API
+- Allows for functionality during build-time, runtime, or for both.
+
+### Game framework
+- Services (`@service`) define individual game logic
+- Controllers (`@controller`) define per-instance behavior and are automatically mapped to instances containing CollectionService tags
+- Dependency injection for services and controllers with automatic load ordering
+- Seamless networking bridge; simply import "remote services" (wrappers of RemoteEvents/Functions) 
+
+----
+
+
+## CLI usage
+To setup your project, run `lua-anot init path/to/project`. This creates a default config file. Don't forget to change the default environment paths if your project setup differs! 
+
+This is mostly a CLI tool; to build a project, run this command: `lua-anot build path/to/project`. This command assumes the project directory contains a `annotations.config.json` file. You may specify a custom filename using the `--config` or `-c` argument.
+
+The program also has a watch command, which detects changes and automatically rebuilds; used via `lua-anot watch`.
+
+### Multiple workspaces
+A workspace represents one individual place synced with rojo. Multi-place games would require using multiple.
+It is also possible to have multiple paths per ennvironment, if you want to.
+
+## Defining custom annotations
+The program contains an easy API to do so!
+```python
+#Runs after annotation parsing
+class MyExtension(Extension):
+    def on_build_test_anot(ctx: AnnotationBuildCtx):
+        print(f'Hello World, {ctx.annotation.name}!')
+
+    #Runs after all files have been processed
+    def on_post_process(ctx: PostProcessCtx):
+        print('Build finished!')
+
+    def load(ctx: ExtensionRegistry):
+        ctx.register_anot(AnnotationDef('moduleTest', scope='module', on_build=self.on_build_test_anot)
+
+
+def load(ctx: ExtensionRegistry):
+    ctx.register_extension(MyExtension())
+```
+
+add it to your project's config file:
+`annotations.config.json`
+```json
+extensions = [
+    ["path", "my_extension/main.py"]
+]
+```
+
+**Note: see the documentation for more info.**
+
+**Since the project uses this API internally for optional extensions, you may also see the sourcecode under `/src/extensions/` for reference!**

lua_annotations-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "lua-annotations"
+version = "0.1.0"
+description = "lua-annotations build-time processor/validator"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "Apache-2.0"
+authors = [{name="pigxity"}]
+
+[project.scripts]
+lua-anot = "lua_annotations.main:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["lua_annotations*"]
+
+[tool.setuptools.package-data]
+lua_annotations = ["templates/**"]

lua_annotations-0.1.0/setup.cfg

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

lua_annotations-0.1.0/src/lua_annotations/api/annotations.py

@@ -0,0 +1,123 @@
+from dataclasses import dataclass, field
+from graphlib import TopologicalSorter
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, Callable, Literal, Optional
+
+ENVIRONMENTS = ('client', 'server', 'shared')
+
+if TYPE_CHECKING:
+    from lua_annotations.build_process import BuildProcessCtx, PostProcessCtx
+    from lua_annotations.parser_schemas import Annotation
+    from parser import FileParser
+
+ARG_SEP = ', '
+
+type retention = Literal['build', 'init', 'runtime']
+type scope = Literal['module', 'method', 'type', 'returned_value']
+type argProcessor = Callable[[str], Any]
+
+@dataclass
+class AnnotationBuildCtx():
+    annotation: 'Annotation'
+    parser: 'FileParser'
+    build_ctx: 'BuildProcessCtx'
+
+type OnBuild = Callable[[AnnotationBuildCtx], None]
+
+#for extensions to define annotations
+@dataclass
+class AnnotationDef():
+    """An annotation definition; all Annotation classes are attached to one of these."""
+    name: str
+    args: list[argProcessor]=field(default_factory=list)
+    kwargs: dict[str, argProcessor]=field(default_factory=dict)
+    retention: retention='build'
+    scope: scope='module'
+    mutual_include: list['AnnotationDef']=field(default_factory=list)
+    mutual_exclude: list['AnnotationDef']=field(default_factory=list)
+    on_build: Optional[OnBuild]=None
+    extends: list['AnnotationDef']=field(default_factory=list)
+    
+
+@dataclass
+class FileBuildCtx():
+    build_ctx: 'BuildProcessCtx'
+    parser: 'FileParser'
+    filepath: Path
+
+type FileBuildHook = Callable[[FileBuildCtx], None]
+type PostBuildHook =  Callable[[PostProcessCtx], None]
+
+class Extension():
+    def on_post_process(self, ctx: PostProcessCtx):
+        ...
+    def on_file_process(self, ctx: FileBuildCtx):
+        ...
+    def load(self, ctx: ExtensionRegistry):
+        ...
+
+
+@dataclass
+class SortedRegistry():
+    """Topologically sorted file_build_hooks and post_build_hooks"""
+    file_build_hooks: list[FileBuildHook]
+    post_build_hooks: list[PostBuildHook]
+    anot_registry: dict[str, AnnotationDef]
+
+class ExtensionRegistry():
+    """Provides an API to register and get extensions"""
+
+    def __init__(self):
+        self.anot_registry: dict[str, AnnotationDef] = {}
+        self.extensions: dict[str, Extension] = {}
+        self.ext_graph: dict[str, list[str]] = {}
+        self.ext_load_order: list[str] = []
+
+
+    def register_extension(self, extension: Extension, deps: list[str] = [], hook_order: Literal['before', 'after']='after'):
+        name = type(extension).__name__
+        extension.hook_order = hook_order
+        self.extensions[name] = extension
+        self.ext_graph[name] = deps
+
+    
+    def register_anot(self, anot: AnnotationDef):
+        self.anot_registry[anot.name] = anot
+
+
+    def sort_extensions(self):
+        ext_layers = [[self.extensions[ext] for ext in layer] for layer in topo_layers(self.ext_graph)]
+        load_exts = [x for y in ext_layers for x in y]
+        hook_exts = [x for y in shift_exts(ext_layers) for x in y]
+
+        for ext in load_exts:
+            ext.load(self)
+
+        return SortedRegistry(
+            [ext.on_file_process for ext in hook_exts],
+            [ext.on_post_process for ext in hook_exts],
+            self.anot_registry
+        )
+
+def shift_exts(layers: list[list[Extension]], flag: str='before'):
+    befores = []
+    for layer in layers:
+        befores += [e for e in layer if e.hook_order == flag]
+        layer[:] = [e for e in layer if e.hook_order != flag]
+
+    if befores:
+        layers[0][:0] = befores
+
+    return layers
+
+def topo_layers(graph: dict[str, list[str]]):
+    ts = TopologicalSorter(graph)
+    ts.prepare()
+
+    layers: list[list[str]] = []
+    while ts.is_active():
+        ready = list(ts.get_ready())
+        ready.sort()
+        layers.append(list(ready))
+        ts.done(*ready)
+    return layers

lua_annotations-0.1.0/src/lua_annotations/api/arguments.py

@@ -0,0 +1,26 @@
+from lua_annotations.exceptions import ParseError
+
+#[val1, val2, val3]
+def list_arg(string: str) -> list[str]:
+    """Converts a string wrapped in [] and seperated by commas into a python list"""
+    if not (string.startswith('[') and string.endswith(']')):
+        raise ParseError('list argument must be wrapped in `[` and `]` characters')
+    string = string[1:-1]
+    if string.strip() == '':
+        return []
+
+    return [s.strip() for s in string.split(',')]
+
+def default_list(str: str):
+    """Tries to call list_arg, but if the argument cannot be parsed into a list, a list wrapped with the string is returned."""
+    try:
+        return list_arg(str)
+    except ParseError:
+        return [str]
+
+def literal_builder(options: list[str]):
+    def f(s: str):
+        if s not in options:
+            raise ParseError(f'{s!r} not in literal options: {options}')
+        return s
+    return f