dissect.cstruct 4.4.dev2__tar.gz → 4.4.dev3__tar.gz

dissect_cstruct-4.4.dev3/.gitattributes

@@ -0,0 +1 @@
+tests/_data/** filter=lfs diff=lfs merge=lfs -text

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.cstruct
-Version: 4.4.dev2
+Version: 4.4.dev3
 Summary: A Dissect module implementing a parser for C-like structures: structure parsing in Python made easy
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Apache License 2.0

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/dissect/cstruct/types/enum.py

@@ -114,13 +114,13 @@ class Enum(BaseType, IntEnum, metaclass=EnumMetaType):
     Enums can be made using any integer type.
 
     Example:
-        When using the default C-style parser, the following syntax is supported:
+        When using the default C-style parser, the following syntax is supported::
 
             enum <name> [: <type>] {
                 <values>
             };
 
-        For example, an enum that has A=1, B=5 and C=6 could be written like so:
+        For example, an enum that has A=1, B=5 and C=6 could be written like so::
 
             enum Test : uint16 {
                 A, B=5, C

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/dissect/cstruct/types/flag.py

@@ -15,13 +15,13 @@ class Flag(BaseType, IntFlag, metaclass=EnumMetaType):
     Flags can be made using any integer type.
 
     Example:
-        When using the default C-style parser, the following syntax is supported:
+        When using the default C-style parser, the following syntax is supported::
 
             flag <name> [: <type>] {
                 <values>
             };
 
-        For example, a flag that has A=1, B=4 and C=8 could be written like so:
+        For example, a flag that has A=1, B=4 and C=8 could be written like so::
 
             flag Test : uint16 {
                 A, B=4, C

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/dissect.cstruct.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.cstruct
-Version: 4.4.dev2
+Version: 4.4.dev3
 Summary: A Dissect module implementing a parser for C-like structures: structure parsing in Python made easy
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Apache License 2.0

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/dissect.cstruct.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 .git-blame-ignore-revs
+.gitattributes
 COPYRIGHT
 LICENSE
 MANIFEST.in
@@ -59,7 +60,8 @@ tests/test_types_void.py
 tests/test_types_wchar.py
 tests/test_utils.py
 tests/utils.py
-tests/data/testdef.txt
-tests/docs/Makefile
-tests/docs/conf.py
-tests/docs/index.rst
+tests/_data/testdef.txt
+tests/_docs/Makefile
+tests/_docs/__init__.py
+tests/_docs/conf.py
+tests/_docs/index.rst

{dissect_cstruct-4.4.dev2/tests/docs → dissect_cstruct-4.4.dev3/tests/_docs}/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -jauto
+SPHINXOPTS    ?= -jauto -w $(BUILDDIR)/warnings.log --fail-on-warning
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = build

{dissect_cstruct-4.4.dev2/tests/docs → dissect_cstruct-4.4.dev3/tests/_docs}/conf.py

@@ -1,3 +1,5 @@
+project = "dissect.cstruct"
+
 extensions = [
     "autoapi.extension",
     "sphinx.ext.autodoc",
@@ -32,3 +34,9 @@ autodoc_typehints = "signature"
 autodoc_member_order = "groupwise"
 
 autosectionlabel_prefix_document = True
+
+suppress_warnings = [
+    # https://github.com/readthedocs/sphinx-autoapi/issues/285
+    "autoapi.python_import_resolution",
+    "ref.python",
+]

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/tests/test_basic.py

@@ -28,7 +28,7 @@ def test_duplicate_type(cs: cstruct, compiled: bool) -> None:
 
 
 def test_load_file(cs: cstruct, compiled: bool) -> None:
-    path = Path(__file__).parent / "data/testdef.txt"
+    path = Path(__file__).parent / "_data/testdef.txt"
 
     cs.loadfile(path, compiled=compiled)
     assert "test" in cs.typedefs

{dissect_cstruct-4.4.dev2 → dissect_cstruct-4.4.dev3}/tox.ini

@@ -54,12 +54,12 @@ deps =
     sphinx-design
     furo
 commands =
-    make -C tests/docs clean
-    make -C tests/docs html
+    make -C tests/_docs clean
+    make -C tests/_docs html
 
 [testenv:docs-linkcheck]
 allowlist_externals = make
 deps = {[testenv:docs-build]deps}
 commands =
-    make -C tests/docs clean
-    make -C tests/docs linkcheck
+    make -C tests/_docs clean
+    make -C tests/_docs linkcheck