ezdgn 0.1.0__tar.gz

ezdgn-0.1.0/Cargo.lock

@@ -0,0 +1,320 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "bumpalo"
+version = "3.20.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649"
+
+[[package]]
+name = "cfb"
+version = "0.14.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a347dcabdae9c31b0825fd6a8bed285ec9c2acb89c47827126d52fa4f59cece3"
+dependencies = [
+ "fnv",
+ "uuid",
+ "web-time",
+]
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "ezdgn-core"
+version = "0.1.0"
+dependencies = [
+ "cfb",
+ "thiserror",
+ "uuid",
+]
+
+[[package]]
+name = "ezdgn-python"
+version = "0.1.0"
+dependencies = [
+ "ezdgn-core",
+ "pyo3",
+]
+
+[[package]]
+name = "fnv"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
+
+[[package]]
+name = "futures-core"
+version = "0.3.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2cd50c473c80f6d7c3670a752354b8e569b1a7cbfdc0419ec88e5edad85e0dc7"
+
+[[package]]
+name = "futures-task"
+version = "0.3.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b231ed28831efb4a61a08580c4bc233ec56bc009f4cd8f52da2c3cb97df0c109"
+
+[[package]]
+name = "futures-util"
+version = "0.3.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a77a90a256fce34da66415271e30f94ee91c57b04b8a2c042d9cf3220179deaa"
+dependencies = [
+ "futures-core",
+ "futures-task",
+ "pin-project-lite",
+ "slab",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "js-sys"
+version = "0.3.103"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "53b44bfcdb3f8d5837a46dae1ca9660a837176eee74a28b229bc626816589102"
+dependencies = [
+ "cfg-if",
+ "futures-util",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.187"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7743783ea728ef5c31194c6590797eed286449b4a4e87d626d8a51f0a94e732"
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "pin-project-lite"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd"
+
+[[package]]
+name = "portable-atomic"
+version = "1.14.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3d20d5497ef88037a52ff98267d066e7f11fcc5e99bbfbd58a42336193aacec3"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.107"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cd274650b21d4bfc26a0a47587962c1edb425f69287324355cd040c3ea66071c"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c5e2a7d2f0d013342f295c048ad19237add5154a55b1c5a254c0ec93d4109078"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca85c467da1bbc8d866eea5deff9cf29ea5f7785054a17da36e65bda9c05845b"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ac53762fd065daa3194dd09337a38bd793a188100fd1a9304c4ab312d901771"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn 2.0.119",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ca3a1557399783172dc5bf39cfca835157732532cba56b71d2292161e53b362"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.119",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f"
+
+[[package]]
+name = "slab"
+version = "0.4.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5"
+
+[[package]]
+name = "syn"
+version = "2.0.119"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "syn"
+version = "3.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a207d6d6a2b7fc470b80443726053f18a2481b7e1eee970597051596567987a3"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "thiserror"
+version = "2.0.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09a43598840e33d5b0331f38c5e30d13bb11c11210a4b58f0d9b18a5a5eefcd9"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "43cbfe0cf76104d42a574802844187e84a305e531ed54455f11fbde0f10541cd"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 3.0.2",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "uuid"
+version = "1.20.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ee48d38b119b0cd71fe4141b30f5ba9c7c5d9f4e7a3a8b4a674e4b6ef789976f"
+dependencies = [
+ "js-sys",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "wasm-bindgen"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4b067c0c11094aef6b7a801c1e34a26affafdf3d051dba08456b868789aaf9a4"
+dependencies = [
+ "cfg-if",
+ "once_cell",
+ "rustversion",
+ "wasm-bindgen-macro",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-macro"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "167ce5e579f6bcf889c4f7175a8a5a585de84e8ff93976ce393efa5f2837aab1"
+dependencies = [
+ "quote",
+ "wasm-bindgen-macro-support",
+]
+
+[[package]]
+name = "wasm-bindgen-macro-support"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f3997c7839262f4ef12cf90b818d6340c18e80f263f1a94bf157d0ec4420380e"
+dependencies = [
+ "bumpalo",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.119",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-shared"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc1b4cb0cc549fcf58d7dfc081778139b3d283a081644e833e84682ad71cea24"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "web-time"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb"
+dependencies = [
+ "js-sys",
+ "wasm-bindgen",
+]

ezdgn-0.1.0/Cargo.toml

@@ -0,0 +1,15 @@
+[workspace]
+members = ["crates/ezdgn-core", "crates/ezdgn-python"]
+resolver = "2"
+
+[workspace.package]
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.83"
+authors = ["neka-nat <nekanat.stock@gmail.com>"]
+description = "Native V7 DGN reader/writer core and Python bindings"
+repository = "https://github.com/monozukuri-ai/ezdgn"
+license = "MIT"
+
+[workspace.dependencies]
+pyo3 = { version = "0.29.0", features = ["abi3-py310"] }

ezdgn-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 neka-nat
+
+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.

ezdgn-0.1.0/PKG-INFO

@@ -0,0 +1,309 @@
+Metadata-Version: 2.4
+Name: ezdgn
+Version: 0.1.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: matplotlib>=3.8 ; extra == 'dev'
+Requires-Dist: pytest>=8.0 ; extra == 'dev'
+Requires-Dist: matplotlib>=3.8 ; extra == 'plot'
+Provides-Extra: dev
+Provides-Extra: plot
+License-File: LICENSE
+Summary: Native V7 DGN reader and seed-based writer for Python powered by Rust
+Keywords: dgn,cad,microstation,parser,rust
+Author-email: neka-nat <nekanat.stock@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/monozukuri-ai/ezdgn
+Project-URL: Issues, https://github.com/monozukuri-ai/ezdgn/issues
+Project-URL: Repository, https://github.com/monozukuri-ai/ezdgn
+
+# ezdgn
+
+`ezdgn` is a native V7 DGN reader and seed-based writer for Python,
+implemented with a pure Rust core and PyO3 bindings.
+
+## Installation
+
+`ezdgn` requires Python 3.10 or newer.
+
+```bash
+python -m pip install ezdgn
+```
+
+Install the optional Matplotlib renderer when preview images are needed:
+
+```bash
+python -m pip install "ezdgn[plot]"
+```
+
+Building from source requires Rust 1.83 or newer. The extension uses Python's
+stable ABI (`abi3`) with a Python 3.10 minimum.
+
+## Supported scope
+
+| Format and operation | Support |
+| --- | --- |
+| V7/ISFF 2D read | Native entities, hierarchy, metadata, linkages, and raw records |
+| V7/ISFF 2D write | Seed-based creation of common primitive entities |
+| V7/ISFF 3D | Signature, raw record, and common-header inspection only |
+| V8 DGN | CFB container identification and directory inspection only |
+
+The V7 reader decodes line, line string, shape, curve, ellipse, arc, text,
+cell, text node, complex chain/shape, and B-spline records as native entities.
+It restores parent/child relationships without flattening component records,
+decodes typed attribute linkages while retaining their exact bytes, applies
+high-precision sub-UOR coordinate corrections alongside the stored integers,
+and resolves outline/fill colors through the active color table. Every record,
+including unsupported control and application elements, retains its original
+bytes.
+
+The writer creates standalone V7 2D files from a caller-supplied seed while
+preserving its units, origin, and design plane. It writes line, line string,
+shape, curve, ellipse, arc, circle-as-ellipse, and raw-byte text entities with
+basic symbology and shape fill linkage. Coordinates outside the seed's design
+plane are rejected instead of silently clipped.
+
+V8 entity semantics and V7 3D geometry are not supported. The writer does not
+yet create cells, complex elements, B-splines, arbitrary linkages, or perform
+in-place editing. The raw V7 record framing is shared by 2D and 3D files, so
+`scan_records()` can inspect a 3D stream safely without implying 3D entity
+support.
+
+## 2D entity API
+
+```python
+import ezdgn
+
+drawing = ezdgn.readfile("drawing.dgn")
+
+# All records remain ordered and lossless. entities contains only top-level
+# graphics; all_entities also includes drawable component records.
+print(len(drawing.elements), len(drawing.entities), len(drawing.all_entities))
+
+for entity in drawing:
+    print(entity.dxftype(), entity.record.level, entity.style)
+
+for line in drawing.query("LINE"):
+    print(line.start_uor, line.end_uor)
+    print(line.start_master, line.end_master)
+
+for text in drawing.query("TEXT"):
+    print(text.text_bytes)
+    print(text.decode_text("cp932"))  # the caller selects the encoding
+
+for cell in drawing.query("CELL"):
+    print(cell.name, cell.origin_master, cell.transform)
+    for component in drawing.children(cell):
+        print("  ", component.dxftype())
+
+for element in drawing.elements:
+    for linkage in element.linkages:
+        print(linkage.kind, linkage.linkage_type_name, linkage.raw_bytes)
+```
+
+Ellipse, arc, curve, and B-spline entities retain their native parameters or
+control records; they are not flattened to polylines. `parent_index` and
+`child_indices` refer to the lossless `drawing.elements` sequence, while
+`drawing.parent()`, `children()`, and `descendants()` resolve the objects.
+Stored integer UOR, sub-UOR-corrected floating UOR, and optional master-unit
+coordinates coexist. `drawing.color_table` is the last type-5, level-1 color
+table in file order; `entity.style.rgb` and `fill_rgb` are resolved from it
+when present.
+
+Known DMRS/database, association ID, shape fill, and high-precision linkages
+have typed fields. Unknown user linkages and malformed trailing attribute bytes
+remain accessible through read-only raw views. Shared-cell definition/instance
+types 34/35 remain raw because the public ISFF chapter does not specify their
+layout.
+
+The high-level `read()`/`readfile()` API deliberately rejects V7 3D files.
+`scan_records()` and `inspect_headers()` still support bounded inspection of
+their shared record framing and metadata.
+
+## Plotting parsed drawings
+
+The optional renderer can display a parsed V7 2D drawing or save it as an
+image without changing the native entity model:
+
+```python
+import ezdgn
+
+drawing = ezdgn.readfile("drawing.dgn")
+
+figure, axes = ezdgn.plot(
+    drawing,
+    text_encoding="cp932",
+    background="#111111",
+)
+figure.savefig("preview.png", dpi=150, bbox_inches="tight")
+
+# Or render and save in one call.
+ezdgn.save_plot(drawing, "preview.png", text_encoding="cp932")
+```
+
+The equivalent CLI command is:
+
+```bash
+ezdgn plot drawing.dgn -o preview.png --encoding cp932
+```
+
+Omit `-o` to open an interactive Matplotlib window. Use `--monochrome` for a
+high-contrast preview, `--hide-text` to suppress text, or
+`--coordinate-space uor` when master-unit coordinates are unavailable. Run
+`ezdgn plot --help` for the complete option list.
+
+Lines, line strings, shapes, ellipses, arcs, text, and drawable components of
+cells and complex elements are rendered. Ellipses and arcs are sampled only
+for display. Native type-11 curves and B-spline curves are previewed from
+their parsed control sequences; the source records and entity parameters are
+never flattened or modified. V7 text does not store its code page, so the
+caller must select the correct encoding for non-ASCII text. Geometry and text
+with compatible display styles are batched to keep large previews practical.
+
+## Seed-based V7 writer
+
+```python
+import ezdgn
+
+doc = ezdgn.new("seed_2d.dgn")
+msp = doc.modelspace()
+
+msp.add_line(
+    (0, 0),
+    (10, 5),
+    dgnattribs={"level": 2, "color": 3, "line_weight": 2},
+)
+msp.add_line_string([(0, 10), (5, 15), (10, 10)])
+msp.add_shape(
+    [(20, 0), (30, 0), (30, 10), (20, 10)],
+    fill_color=6,
+)
+msp.add_ellipse((25, 25), primary_axis=5, secondary_axis=3, rotation=30)
+msp.add_arc(
+    (40, 5),
+    primary_axis=5,
+    secondary_axis=3,
+    start_angle=30,
+    sweep_angle=120,
+)
+msp.add_text("日本語", (0, 30), height=2, encoding="cp932")
+
+doc.saveas("drawing.dgn")
+roundtrip = doc.readback()
+```
+
+By default `new()` copies the mandatory TCB, digitizer setup, level symbology,
+and the last active color table from the seed. Set `copy_seed_elements=True`
+to retain every existing seed record, including any graphics. Text encoding is
+not recorded by V7 DGN, so `add_text()` accepts bytes directly or requires the
+caller-selected encoding for `str` input.
+
+## Raw record API
+
+```python
+import ezdgn
+
+info = ezdgn.detect_format("drawing.dgn")
+print(info.kind, info.dimension)
+
+scan = ezdgn.scan_records("drawing.dgn")
+print(len(scan.records), scan.termination)
+
+for record in scan.records:
+    print(record.offset, record.element_type, record.level, record.raw_bytes)
+```
+
+The `V8_CFB` result means that the input has the generic CFB signature used by
+V8 DGN files. It is intentionally described as a candidate because the outer
+signature alone does not prove that DGN-specific streams are present.
+
+The bounded container inspector verifies the known DGN root markers without
+decoding proprietary V8 stream contents:
+
+```python
+container = ezdgn.inspect_v8_container("drawing-v8.dgn")
+print(container.has_dgn_v8_markers)
+print(container.model_storage_paths)
+for entry in container.entries:
+    print(entry.path, entry.kind, entry.size_bytes)
+```
+
+This is structural identification, not V8 entity support or a fidelity
+guarantee. `ezdgn.read()`, `readfile()`, and `scan_records()` reject V8 input
+instead of silently flattening or converting it. If a workflow converts V8 to
+V7 outside `ezdgn`, validate the resulting geometry, text, levels, styles, and
+complex/cell relationships before treating it as equivalent to the source.
+
+## Design settings and common headers
+
+```python
+import ezdgn
+
+headers = ezdgn.inspect_headers("drawing.dgn")
+settings = headers.design_settings
+
+print(settings.master_unit_name, settings.uor_per_master)
+print(settings.global_origin_master)
+
+for element in headers.elements:
+    common = element.common_header
+    if common is not None:
+        print(
+            element.record.element_type,
+            common.range.low_master,
+            common.range.high_master,
+            common.symbology.color,
+        )
+```
+
+`read_design_settings()` decodes only the leading TCB. `inspect_headers()`
+pairs every raw record with its standard common header when that element type
+has one. Attribute bytes remain available as a read-only zero-copy
+`ElementMetadata.attribute_view`.
+
+The same inspection is available from the CLI:
+
+```bash
+ezdgn inspect drawing.dgn
+ezdgn inspect drawing.dgn --records --json
+ezdgn inspect drawing.dgn --headers --json
+ezdgn inspect drawing.dgn --entities --json
+ezdgn inspect drawing-v8.dgn --json
+```
+
+## Development
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install "maturin>=1.13,<2" "pytest>=8" "matplotlib>=3.8"
+maturin develop
+cargo fmt --check
+cargo clippy --workspace --all-targets --all-features -- -D warnings
+cargo test --workspace
+python -m pytest
+```
+
+Build a distributable wheel with:
+
+```bash
+maturin build --release --out dist
+```
+
+## License
+
+`ezdgn` is released under the [MIT License](LICENSE). Test fixtures retain the
+separate upstream terms documented in
+[`tests/data/dgn/README.md`](tests/data/dgn/README.md).
+