revised Field metaclass

* added a FieldMeta for better processing * renamed _Field as FieldBase for clearer indication
JarryShaw · Oct 4, 2023 · c3a79e7 · c3a79e7
1 parent 1b638cc
commit c3a79e7
Show file tree

Hide file tree

Showing 27 changed files with 261 additions and 243 deletions.
diff --git a/docs/source/pcapkit/corekit/fields.rst b/docs/source/pcapkit/corekit/fields.rst
diff --git a/docs/source/pcapkit/corekit/fields/collections.rst b/docs/source/pcapkit/corekit/fields/collections.rst
@@ -0,0 +1,12 @@
+Container Fields
+----------------
+
+.. module:: pcapkit.corekit.fields.collections
+
+.. autoclass:: pcapkit.corekit.fields.collections.ListField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.collections.OptionField
+   :members:
+   :show-inheritance:
diff --git a/docs/source/pcapkit/corekit/fields/index.rst b/docs/source/pcapkit/corekit/fields/index.rst
@@ -0,0 +1,40 @@
+Protocol Fields
+===============
+
+.. module:: pcapkit.corekit.fields
+
+:mod:`pcapkit.corekit.fields` is collection of protocol fields,
+descriptive of the structure of protocol headers.
+
+.. toctree::
+   :maxdepth: 2
+
+   numbers
+   strings
+   ipaddress
+   collections
+   misc
+
+Base Fields
+-----------
+
+.. module:: pcapkit.corekit.fields.field
+
+.. autoclass:: pcapkit.corekit.fields.field.FieldMeta
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.field.FieldBase
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.field.Field
+   :members:
+   :show-inheritance:
+
+Auxiliary
+~~~~~~~~~
+
+.. autoclass:: pcapkit.corekit.fields.field.NoValueType
+.. autodata:: pcapkit.corekit.fields.field.NoValue
+   :no-value:
diff --git a/docs/source/pcapkit/corekit/fields/ipaddress.rst b/docs/source/pcapkit/corekit/fields/ipaddress.rst
@@ -0,0 +1,38 @@
+IP Address Fields
+-----------------
+
+.. module:: pcapkit.corekit.fields.ipaddress
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress._IPField
+   :members:
+   :show-inheritance:
+
+IP Addresses
+~~~~~~~~~~~~
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress._IPAddressField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress.IPv4AddressField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress.IPv6AddressField
+   :members:
+   :show-inheritance:
+
+IP Interface
+~~~~~~~~~~~~
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress._IPInterfaceField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress.IPv4InterfaceField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.ipaddress.IPv6InterfaceField
+   :members:
+   :show-inheritance:
diff --git a/docs/source/pcapkit/corekit/fields/misc.rst b/docs/source/pcapkit/corekit/fields/misc.rst
@@ -0,0 +1,24 @@
+Miscellaneous Fields
+--------------------
+
+.. module:: pcapkit.corekit.fields.misc
+
+.. autoclass:: pcapkit.corekit.fields.misc.ConditionalField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.misc.PayloadField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.misc.SwitchField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.misc.ForwardMatchField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.misc.NoValueField
+   :members:
+   :show-inheritance:
diff --git a/docs/source/pcapkit/corekit/fields/numbers.rst b/docs/source/pcapkit/corekit/fields/numbers.rst
@@ -0,0 +1,44 @@
+Numerical Fields
+----------------
+
+.. module:: pcapkit.corekit.fields.numbers
+
+.. autoclass:: pcapkit.corekit.fields.numbers.NumberField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.Int32Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.UInt32Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.Int16Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.UInt16Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.Int64Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.UInt64Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.Int8Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.UInt8Field
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.numbers.EnumField
+   :members:
+   :show-inheritance:
diff --git a/docs/source/pcapkit/corekit/fields/strings.rst b/docs/source/pcapkit/corekit/fields/strings.rst
@@ -0,0 +1,24 @@
+Text Fields
+-----------
+
+.. module:: pcapkit.corekit.fields.strings
+
+.. autoclass:: pcapkit.corekit.fields.strings._TextField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.strings.BytesField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.strings.StringField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.strings.BitField
+   :members:
+   :show-inheritance:
+
+.. autoclass:: pcapkit.corekit.fields.strings.PaddingField
+   :members:
+   :show-inheritance:
diff --git a/docs/source/pcapkit/corekit/index.rst b/docs/source/pcapkit/corekit/index.rst
@@ -15,7 +15,7 @@ and :class:`~pcapkit.corekit.multidict.MultiDict` family inspired from
 .. toctree::
    :maxdepth: 2
 
-   fields
+   fields/index
    infoclass
    io
    module