pkl-python 0.0.0__py3-none-any.whl

pkl/server.py

@@ -0,0 +1,156 @@
+import atexit
+import os
+import platform
+import signal
+import stat
+import subprocess
+from pathlib import Path
+
+import msgpack
+import requests
+
+BINARIES = {
+    ("darwin", "64bit"): "pkl-macos-amd64",
+    ("darwin", "aarch64"): "pkl-macos-aarch64",
+    ("linux", "64bit"): "pkl-linux-amd64",
+    ("linux", "aarch64"): "pkl-linux-aarch64",
+    ("linux", "64bit", "alpine"): "pkl-alpine-linux-amd64",
+}
+PKL_VERSION = "0.25.3"
+BASE_PATH = "https://github.com/apple/pkl/releases/download/"
+
+
+def preexec_function():
+    # Cause the child process to be terminated when the parent exits
+    signal.signal(signal.SIGHUP, signal.SIG_IGN)
+
+
+def detect_system():
+    os_name = platform.system().lower()
+    arch, _ = platform.architecture()
+    return os_name, arch
+
+
+def is_alpine_linux():
+    return os.path.isfile("/etc/alpine-release")
+
+
+def execute_binary(binary_path):
+    subprocess.run([binary_path, "server"], check=True)
+
+
+def download_binary(file, target_fp):
+    url = BASE_PATH + PKL_VERSION + "/" + file
+    response = requests.get(url)
+    with open(target_fp, "wb") as f:
+        f.write(response.content)
+
+
+def get_binary_path():
+    os_name, arch = detect_system()
+    if os_name == "linux" and is_alpine_linux():
+        os_name = "alpine"
+    binary_key = (os_name, arch)
+    if binary_key == ("linux", "64bit") and is_alpine_linux():
+        binary_key += ("alpine",)
+    bin_file = BINARIES.get(binary_key)
+
+    if bin_file is None:
+        raise OSError("No compatible binary found for your system.")
+
+    bin_parent_path = (Path("~/.pkl/bin/") / PKL_VERSION).expanduser()
+    binary_path = bin_parent_path / bin_file
+
+    if not binary_path.exists():
+        binary_path.parent.mkdir(exist_ok=True, parents=True)
+        download_binary(bin_file, binary_path)
+
+    current_permissions = os.stat(binary_path).st_mode
+    new_permissions = current_permissions | stat.S_IXUSR
+    os.chmod(binary_path, new_permissions)
+
+    return binary_path
+
+
+_PROCESSES = []
+
+
+def terminate_processes():
+    for process in _PROCESSES:
+        process.terminate()
+        process.wait()
+
+
+atexit.register(terminate_processes)
+
+
+class PKLServer:
+    def __init__(self, cmd=None, debug=False):
+        self.cmd = cmd or [get_binary_path(), "server"]
+        self.next_request_id = 1
+        self.unpacker = msgpack.Unpacker()
+
+        env = {"PKL_DEBUG": "1"} if debug else {}
+
+        self.process = subprocess.Popen(
+            self.cmd,
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=False,
+            bufsize=0,
+            preexec_fn=preexec_function,
+            env=env,
+        )
+        self.stdout = self.process.stdout
+        self.stdin = self.process.stdin
+        self.stderr = self.process.stderr
+        self.closed = False
+
+        os.set_blocking(self.stdout.fileno(), False)
+        os.set_blocking(self.stderr.fileno(), False)
+        _PROCESSES.append(self.process)
+
+    def get_request_id(self):
+        ret = self.next_request_id
+        self.next_request_id += 1
+        return ret
+
+    def send(self, msg):
+        if self.closed:
+            raise ValueError("Server closed")
+        self.stdin.write(msg)
+        self.stdin.flush()
+
+    def _read(self, stream):
+        msg = None
+        while msg is None:
+            msg = stream.read()
+        return msg
+
+    def _receive(self, stream):
+        while True:
+            for unpacked in self.unpacker:
+                return unpacked
+            msg = self._read(stream)
+            self.unpacker.feed(msg)
+
+    def receive(self):
+        if self.closed:
+            raise ValueError("Server closed")
+        return self._receive(self.stdout)
+
+    def receive_err(self):
+        if self.closed:
+            raise ValueError("Server closed")
+        msg = self.stderr.read()
+        if msg is not None:
+            print(msg.decode(), end="")
+
+    def terminate(self):
+        self.process.terminate()
+        self.process.stdout.close()
+        self.process.stderr.close()
+        self.process.stdin.close()
+        self.process.wait()
+        self.closed = True

pkl/utils.py

@@ -0,0 +1,33 @@
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Optional, Union
+from urllib.parse import urlparse
+
+
+class PklBugError(Exception):
+    pass
+
+
+class PklError(Exception):
+    pass
+
+
+@dataclass
+class ModuleSource:
+    uri: str
+    text: Optional[str] = None
+
+    @classmethod
+    def from_path(cls, path: Union[str, Path]):
+        uri = Path(path).absolute().as_uri()
+        return cls(uri=uri)
+
+    @classmethod
+    def from_text(cls, text: str):
+        return cls(uri="repl:text", text=text)
+
+    @classmethod
+    def from_uri(cls, uri):
+        res = urlparse(uri)
+        parsed = res.geturl()
+        return cls(uri=parsed)

pkl_python-0.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jungwoo Yang
+
+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.

pkl_python-0.0.0.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.1
+Name: pkl-python
+Version: 0.0.0
+Summary: Python library for Apple's PKL.
+Author-email: Jungwoo Yang <jwyang0213@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Jungwoo Yang
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/jw-y/pkl
+Project-URL: Bug Reports, https://github.com/jw-y/pkl/issues
+Project-URL: Source, https://github.com/jw-y/pkl
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: msgpack >=1.0.8
+Provides-Extra: dev
+Requires-Dist: pre-commit ; extra == 'dev'
+Requires-Dist: black ; extra == 'dev'
+Requires-Dist: isort ; extra == 'dev'
+Requires-Dist: mypy ; extra == 'dev'
+Requires-Dist: pylint ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: tox ; extra == 'dev'
+
+> [!CAUTION]
+>
+> # THIS LIBRARY IS CURRENTLY PRE-RELEASE
+>
+> `pkl-python` is currently major version `v0`, and **breaking changes will happen** between versions.
+
+# pkl-python - Pkl Bindings for Python
+Python binding for [Apple's Pkl language](https://pkl-lang.org/index.html).
+
+## Getting Started
+### Installation
+
+``` bash
+pip install pkl-python
+```
+
+### Basic Usage
+Here's how you can start using `pkl-python` to load a PKL module:
+
+```python
+import pkl
+
+config = pkl.load("path/to/pkl/example_module.pkl")
+print(config)
+```
+
+### Status
+* Evaluator API: fully functional
+* Code Generation: in development
+
+### TODO
+* [x] (codgen) fix class order
+* [ ] (codgen) pip binary installation
+* [ ] (codgen) clean up code
+
+
+## Usage
+
+## Advanced Features
+For details on the parameters, refer [Message Passing API](https://pkl-lang.org/main/current/bindings-specification/message-passing-api.html).
+
+```python
+import pkl
+
+config = pkl.load("./tests/types.pkl")
+config = pkl.load("./tests/types.pkl", expr="datasize")
+config = pkl.load(None, module_text="a: Int = 1 + 1")
+config = pkl.load("./tests/types.pkl", debug=True)
+```
+
+### Custom Readers
+It is possible to add module or resource or module readers:
+```python
+from typing import List
+from dataclasses import dataclass
+
+import pkl
+from pkl import (
+    ModuleReader, ResourceReader, PathElement,
+    ModuleSource, PreconfiguredOptions, PklError,
+)
+
+class TestModuleReader(ModuleReader):
+    def read(self, url) -> str:
+        return "foo = 1"
+
+    def list_elements(self, url: str) -> List[PathElement]:
+        return [PathElement("foo.pkl", False)]
+
+opts = PreconfiguredOptions(
+    moduleReaders=[TestModuleReader("customfs", True, True, True)]
+)
+opts.allowedModules.append("customfs:")
+config = pkl.load("./tests/myModule.pkl", evaluator_options=opts)
+```
+
+## Appendix
+
+### Type Mappings
+
+While in pre-release they are subject to change.
+
+| Pkl type         | TypeScript type            |
+| ---------------- | -------------------------- |
+| Null             | `None`                     |
+| Boolean          | `bool`                     |
+| String           | `str`                      |
+| Int              | `int`                      |
+| Int8             | `int`                      |
+| Int16            | `int`                      |
+| Int32            | `int`                      |
+| UInt             | `int`                      |
+| UInt8            | `int`                      |
+| UInt16           | `int`                      |
+| UInt32           | `int`                      |
+| Float            | `float`                    |
+| Number           | `float`                    |
+| List             | `list`                     |
+| Listing          | `list`                     |
+| Map              | `dict`                     |
+| Mapping          | `dict`                     |
+| Set              | `set`                      |
+| Pair             | `pkl.Pair`                 |
+| Dynamic          | `dataclasses.dataclass`    |
+| DataSize         | `pkl.DataSize`             |
+| Duration         | `pkl.Duration`             |
+| IntSeq           | `pkl.IntSeq`               |
+| Class            | `dataclasses.dataclass`    |
+| TypeAlias        | `typing`                   |
+| Any              | `typing.Any`               |
+| Unions (A\|B\|C) | `typing.Union[A\|B\|C]`    |
+| Regex            | `pkl.Regex`                |
+
+## Contributing
+Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+PKL is released under the MIT License. See the LICENSE file for more details.
+
+## Contact
+For support or to contribute, please contact jwyang0213@gmail.com or visit our GitHub repository to report issues or submit pull requests.

pkl_python-0.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+pkl/__init__.py,sha256=FebsX_7t0B6Up7ZuSV8eRNBcRYmy317gdnZ-l4QjzfU,3970
+pkl/evaluator_manager.py,sha256=uPvOQMGG6xhpdIAdAqGUqlB-P4TVxeR1nZ76b1DkGIQ,12637
+pkl/evaluator_options.py,sha256=KLe37agqCidUJvWfUIGuCbIDW9LzJSsGv10yR9W_eWk,4841
+pkl/msgapi.py,sha256=wlX1t0eqB4Vj0d2KYgosy3LsA92eX5tE6GwugJqQRqU,8111
+pkl/parser.py,sha256=ygrY68Bo-hFTas07iHwL2ZDTS9uPeCgjFCmOWsjmN4g,6260
+pkl/reader.py,sha256=z3fHHt5nZuu-Q7RqXB9wWeEdA8-jFyf0yizuT4y6Ix0,1780
+pkl/server.py,sha256=Rof4heSCvrFSoc6ggt69soKmLRcuur3UaK6y0LMykRU,4114
+pkl/utils.py,sha256=1SFKaIdFgDo8Z8fVBtq_5LZeKb2qNF2fuTDLbG58WVg,658
+pkl_python-0.0.0.dist-info/LICENSE,sha256=xakNlyP5yr5S03TW66xSAFmKjgc3eC4Dxz0ggbmFzFM,1069
+pkl_python-0.0.0.dist-info/METADATA,sha256=YhjQbrkFWI2vKLfxTV4Fv0cYAmkLr8pkB_NYa55qB8o,5998
+pkl_python-0.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pkl_python-0.0.0.dist-info/entry_points.txt,sha256=awJKbVyaDuuDJuBfTUUOkJ0tdfpPFCh5AjmW9uC8FZI,55
+pkl_python-0.0.0.dist-info/top_level.txt,sha256=bOuzzlEm20X6PyirtLenvxqt_ukmxWuxP4odSZyuD80,4
+pkl_python-0.0.0.dist-info/RECORD,,

pkl_python-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pkl_python-0.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pkl-gen-python = pkl_gen_python:main

pkl_python-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pkl