postseed 0.1.0__py3-none-any.whl

postseed/__init__.py

@@ -0,0 +1,111 @@
+"""Postseed for Python: realistic, relationship-correct seed data for PostgreSQL.
+
+This package carries the same engine as the ``postseed`` npm package and runs it with Node.js 20 or newer.
+Use the ``postseed`` command, or call :func:`generate` to get seed SQL for a schema from Python.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+from typing import Dict, List, Mapping, Optional, Sequence
+
+__all__ = ["__version__", "PostseedError", "NodeNotFoundError", "find_node", "run", "generate"]
+__version__ = "0.1.0"
+
+MIN_NODE = 20
+ENGINE = Path(__file__).resolve().parent / "_engine" / "postseed.mjs"
+
+
+class PostseedError(RuntimeError):
+    """The Postseed engine reported an error."""
+
+
+class NodeNotFoundError(PostseedError):
+    """Node.js 20 or newer is required and was not found."""
+
+
+def find_node() -> str:
+    """Path of a Node.js 20+ executable. Set POSTSEED_NODE to choose one explicitly."""
+    candidate = os.environ.get("POSTSEED_NODE") or shutil.which("node") or shutil.which("nodejs")
+    if not candidate:
+        raise NodeNotFoundError(
+            "Postseed needs Node.js %d or newer, and none was found on your PATH. "
+            "Install it from https://nodejs.org (or set POSTSEED_NODE to the node executable)." % MIN_NODE
+        )
+    try:
+        out = subprocess.run([candidate, "--version"], capture_output=True, text=True, timeout=15).stdout.strip()
+        major = int(out.lstrip("v").split(".")[0])
+    except (OSError, ValueError, subprocess.SubprocessError) as exc:
+        raise NodeNotFoundError(
+            "Could not run Node.js at %s (%s). Postseed needs Node.js %d or newer; "
+            "install it from https://nodejs.org or fix POSTSEED_NODE." % (candidate, exc, MIN_NODE)
+        ) from exc
+    if major < MIN_NODE:
+        raise NodeNotFoundError("Postseed needs Node.js %d or newer; found %s at %s." % (MIN_NODE, out, candidate))
+    return candidate
+
+
+def _command(args: Sequence[str]) -> List[str]:
+    if not ENGINE.exists():
+        raise PostseedError("The bundled engine is missing (%s). Reinstall the postseed package." % ENGINE)
+    return [find_node(), str(ENGINE), *args]
+
+
+def run(
+    args: Sequence[str],
+    *,
+    input: Optional[str] = None,
+    cwd: Optional[str] = None,
+    env: Optional[Mapping[str, str]] = None,
+) -> "subprocess.CompletedProcess[str]":
+    """Run the Postseed CLI and capture its output. Does not raise on a non-zero exit."""
+    return subprocess.run(
+        _command(args),
+        input=input,
+        capture_output=True,
+        text=True,
+        encoding="utf-8",
+        cwd=cwd,
+        env={**os.environ, **env} if env else None,
+    )
+
+
+def generate(
+    schema_sql: str,
+    *,
+    rows: int = 50,
+    seed: int = 42,
+    format: str = "sql",
+    tables: Optional[Sequence[str]] = None,
+    table_rows: Optional[Mapping[str, int]] = None,
+    null_ratio: Optional[float] = None,
+    now: Optional[str] = None,
+) -> str:
+    """Generate seed data for a ``CREATE TABLE`` script and return it as text.
+
+    ``format`` is ``"sql"`` or ``"json"`` (CSV writes several files; use the CLI with ``--out``).
+    The same schema, seed and Postseed version always return identical text. Raises
+    :class:`PostseedError` with the engine's message if generation fails.
+    """
+    if format not in ("sql", "json"):
+        raise ValueError('format must be "sql" or "json" (use the CLI for csv)')
+    args = ["generate", "--schema", "-", "--rows", str(int(rows)), "--seed", str(int(seed)), "--format", format]
+    if tables:
+        args += ["--tables", ",".join(tables)]
+    if table_rows:
+        args += ["--table-rows", ",".join("%s=%d" % (k, v) for k, v in table_rows.items())]
+    if null_ratio is not None:
+        args += ["--null-ratio", str(null_ratio)]
+    if now:
+        args += ["--now", now]
+    done = run(args, input=schema_sql)
+    if done.returncode != 0:
+        raise PostseedError((done.stderr or done.stdout).strip() or "postseed exited with %d" % done.returncode)
+    if format == "json":
+        json.loads(done.stdout)  # fail loudly if the output is not valid JSON
+    return done.stdout

postseed/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())

postseed/_engine/node_modules/jiti/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+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.

postseed/_engine/node_modules/jiti/README.md

@@ -0,0 +1,258 @@
+# jiti
+
+<!-- automd:badges color=F0DB4F bundlephobia -->
+
+[![npm version](https://img.shields.io/npm/v/jiti?color=F0DB4F)](https://npmjs.com/package/jiti)
+[![npm downloads](https://img.shields.io/npm/dm/jiti?color=F0DB4F)](https://npmjs.com/package/jiti)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/jiti?color=F0DB4F)](https://bundlephobia.com/package/jiti)
+
+<!-- /automd -->
+
+> This is the active development branch. Check out [jiti/v1](https://github.com/unjs/jiti/tree/v1) for legacy v1 docs and code.
+
+## 🌟 Used in
+
+[Docusaurus](https://docusaurus.io/), [ESLint](https://github.com/eslint/eslint), [FormKit](https://formkit.com/), [Histoire](https://histoire.dev/), [Knip](https://knip.dev/), [Nitro](https://nitro.unjs.io/), [Nuxt](https://nuxt.com/), [PostCSS loader](https://github.com/webpack-contrib/postcss-loader), [Rsbuild](https://rsbuild.dev/), [Size Limit](https://github.com/ai/size-limit), [Slidev](https://sli.dev/), [Tailwindcss](https://tailwindcss.com/), [Tokenami](https://github.com/tokenami/tokenami), [UnoCSS](https://unocss.dev/), [WXT](https://wxt.dev/), [Winglang](https://www.winglang.io/), [Graphql code generator](https://the-guild.dev/graphql/codegen), [Lingui](https://lingui.dev/), [Scaffdog](https://scaff.dog/), [Storybook](https://storybook.js.org), [...UnJS ecosystem](https://unjs.io/), [...60M+ npm monthly downloads](https://npm.chart.dev/jiti), [...6M+ public repositories](https://github.com/unjs/jiti/network/dependents).
+
+## ✅ Features
+
+- Seamless TypeScript and ESM syntax support for Node.js
+- Seamless interoperability between ESM and CommonJS
+- Asynchronous API to replace `import()`
+- Synchronous API to replace `require()` (deprecated)
+- Super slim and zero dependency
+- Custom resolve aliases
+- Smart syntax detection to avoid extra transforms
+- Node.js native `require.cache` integration
+- Filesystem transpile with hard disk caches
+- ESM Loader support
+- JSX support (opt-in)
+
+> [!IMPORTANT]
+> To enhance compatibility, jiti `>=2.1` enabled [`interopDefault`](#interopdefault) using a new Proxy method. If you migrated to `2.0.0` earlier, this might have caused behavior changes. In case of any issues during the upgrade, please [report](https://github.com/unjs/jiti/issues) so we can investigate to solve them. 🙏🏼
+
+## 💡 Usage
+
+### CLI
+
+You can use `jiti` CLI to quickly run any script with TypeScript and native ESM support!
+
+```bash
+npx jiti ./index.ts
+```
+
+### Programmatic
+
+Initialize a jiti instance:
+
+```js
+// ESM
+import { createJiti } from "jiti";
+const jiti = createJiti(import.meta.url);
+
+// CommonJS (deprecated)
+const { createJiti } = require("jiti");
+const jiti = createJiti(__filename);
+```
+
+Import (async) and resolve with ESM compatibility:
+
+```js
+// jiti.import(id) is similar to import(id)
+const mod = await jiti.import("./path/to/file.ts");
+
+// jiti.esmResolve(id) is similar to import.meta.resolve(id)
+const resolvedPath = jiti.esmResolve("./src");
+```
+
+If you need the default export of module, you can use `jiti.import(id, { default: true })` as shortcut to `mod?.default ?? mod`.
+
+```js
+// shortcut to mod?.default ?? mod
+const modDefault = await jiti.import("./path/to/file.ts", { default: true });
+```
+
+CommonJS (sync & deprecated):
+
+```js
+// jiti() is similar to require(id)
+const mod = jiti("./path/to/file.ts");
+
+// jiti.resolve() is similar to require.resolve(id)
+const resolvedPath = jiti.resolve("./src");
+```
+
+You can also pass options as the second argument:
+
+```js
+const jiti = createJiti(import.meta.url, { debug: true });
+```
+
+### Register global ESM loader
+
+You can globally register jiti using [global hooks](https://nodejs.org/api/module.html#initialize). (Important: Requires Node.js > 20)
+
+```js
+import "jiti/register";
+```
+
+Or:
+
+```bash
+node --import jiti/register index.ts
+```
+
+## 🎈 `jiti/native`
+
+You can alias `jiti` to `jiti/native` to directly depend on runtime's [`import.meta.resolve`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta/resolve) and dynamic [`import()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) support. This allows easing up the ecosystem transition to runtime native support by giving the same API of jiti.
+
+## ⚙️ Options
+
+### `debug`
+
+- Type: Boolean
+- Default: `false`
+- Environment variable: `JITI_DEBUG`
+
+Enable verbose logging. You can use `JITI_DEBUG=1 <your command>` to enable it.
+
+### `fsCache`
+
+- Type: Boolean | String
+- Default: `true`
+- Environment variable: `JITI_FS_CACHE`
+
+Filesystem source cache (enabled by default)
+
+By default (when is `true`), jiti uses `node_modules/.cache/jiti` (if exists) or `{TMP_DIR}/jiti`.
+
+**Note:** It is recommended that this option be enabled for better performance.
+
+### `rebuildFsCache`
+
+- Type: Boolean
+- Default: `false`
+- Environment variable: `JITI_REBUILD_FS_CACHE`
+
+Rebuild filesystem source cache created by `fsCache`.
+
+### `moduleCache`
+
+- Type: String
+- Default: `true`
+- Environment variable: `JITI_MODULE_CACHE`
+
+Runtime module cache (enabled by default).
+
+Disabling allows editing code and importing the same module multiple times.
+
+When enabled, jiti integrates with Node.js native CommonJS cache-store.
+
+### `transform`
+
+- Type: Function
+- Default: Babel (lazy loaded)
+
+Transform function. See [src/babel](./src/babel.ts) for more details
+
+### `sourceMaps`
+
+- Type: Boolean
+- Default `false`
+- Environment variable: `JITI_SOURCE_MAPS`
+
+Add inline source map to transformed source for better debugging.
+
+### `interopDefault`
+
+- Type: Boolean
+- Default: `true`
+- Environment variable: `JITI_INTEROP_DEFAULT`
+
+Jiti combines module exports with the `default` export using an internal Proxy to improve compatibility with mixed CJS/ESM usage. You can check the current implementation [here](https://github.com/unjs/jiti/blob/main/src/utils.ts#L105).
+
+> [!WARNING]
+> This option wraps **all imported modules** in a Proxy, which adds ~25-50ns overhead per property access. For performance-critical hot paths where you access module exports very frequently, consider setting `interopDefault: false` or `JITI_INTEROP_DEFAULT=false`.
+
+### `alias`
+
+- Type: Object
+- Default: -
+- Environment variable: `JITI_ALIAS`
+
+You can also pass an object to the environment variable for inline config. Example: `JITI_ALIAS='{"~/*": "./src/*"}' jiti ...`.
+
+Custom alias map used to resolve IDs.
+
+### `tsconfigPaths`
+
+- Type: Boolean | String
+- Default: `false`
+- Environment variable: `JITI_TSCONFIG_PATHS`
+
+Enable TypeScript [`paths`](https://www.typescriptlang.org/tsconfig/#paths) resolution using [`get-tsconfig`](https://github.com/privatenumber/get-tsconfig).
+
+- `true`: Auto-discover `tsconfig.json` by walking up from the jiti instance's parent path.
+- `string`: Explicit path to a `tsconfig.json` file.
+- `false` (default): Disabled.
+
+### `nativeModules`
+
+- Type: Array
+- Default: ['typescript']
+- Environment variable: `JITI_NATIVE_MODULES`
+
+List of modules (within `node_modules`) to always use native `require()` for them.
+
+### `transformModules`
+
+- Type: Array
+- Default: []
+- Environment variable: `JITI_TRANSFORM_MODULES`
+
+List of modules (within `node_modules`) to transform them regardless of syntax.
+
+### `importMeta`
+
+Parent module's [`import.meta`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta) context to use for ESM resolution. (only used for `jiti/native` import).
+
+### `tryNative`
+
+- Type: Boolean
+- Default: Enabled if bun is detected
+- Environment variable: `JITI_TRY_NATIVE`
+
+Try to use native require and import without jiti transformations first.
+
+### `jsx`
+
+- Type: Boolean | {options}
+- Default: `false`
+- Environment Variable: `JITI_JSX`
+
+Enable JSX support using [`@babel/plugin-transform-react-jsx`](https://babeljs.io/docs/babel-plugin-transform-react-jsx).
+
+See [`test/fixtures/jsx`](./test/fixtures/jsx) for framework integration examples.
+
+## Development
+
+- Clone this repository
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run `pnpm dev`
+- Run `pnpm jiti ./test/path/to/file.ts`
+
+## License
+
+<!-- automd:contributors license=MIT author="pi0" -->
+
+Published under the [MIT](https://github.com/unjs/jiti/blob/main/LICENSE) license.
+Made by [@pi0](https://github.com/pi0) and [community](https://github.com/unjs/jiti/graphs/contributors) 💛
+<br><br>
+<a href="https://github.com/unjs/jiti/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=unjs/jiti" />
+</a>
+
+<!-- /automd -->
+
+<!-- automd:with-automd -->