libknot 3.3.15.dev0__tar.gz → 3.3.17.dev0__tar.gz

{libknot-3.3.15.dev0 → libknot-3.3.17.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libknot
-Version: 3.3.15.dev0
+Version: 3.3.17.dev0
 Summary: Python bindings for libknot
 Home-page: https://gitlab.nic.cz/knot/knot-dns/-/tree/master/python/libknot
 Author: CZ.NIC, z.s.p.o.
@@ -61,7 +61,7 @@ The module API is stored in `libknot.control`.
 ### Protocol overview<a id="kctl-proto"></a>
 
 Connections are supposed to be short-lived, because maintaining a passive
-connection is costly for the server. Therefore the expected usage of the CTL
+connection is costly for the server. Therefore the expected usage of the control
 interface is to always open a new connection on demand, then close it once it's
 not immediately needed.
 
@@ -81,7 +81,7 @@ then sent along with the next `END` or `BLOCK` unit.
 A unit can optionaly hold data, though this is only meaningful for the `DATA`
 and `EXTRA` types. The data consists of several sections of which usually only
 a few at a time will be present. For example when a unit issuing a `stats`
-command is sent, there is no reason for it to contain an `ERROR` section.
+command is sent, there is no reason for it to contain an `ID` section.
 
 The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 
@@ -89,7 +89,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 | ------------ | ----------------------- | ------------------------------------------------------ |
 | `COMMAND`    | cmd                     | Command name.                                          |
 | `FLAGS`      | flags                   | Command flags.                                         |
-| `ERROR`      | *n/a*                   | Error message. Only sent by the server.                |
+| `ERROR`      | *(n/a)*                 | Error message. Only sent by the server.                |
 | `SECTION`    | section                 | Configuration section name.                            |
 | `ITEM`       | item                    | Configuration item name.                               |
 | `ID`         | identifier              | Configuration item identifier.                         |
@@ -102,7 +102,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 
 ### Commands reference<a id="kctl-cmds"></a>
 
-The following is a reference for the low-level CTL API. In case you're unsure
+The following is a reference for the low-level control API. In case you're unsure
 of the commands' semantics, please consult the
 <a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
 
@@ -115,19 +115,22 @@ cmd-name(SECTION_NAME, [OPT_SECTION])
 
 [OPT_SECTION="literal value"],   # Optional section with fixed expected value.
 [SECTION1, SECTION2]             # Sections must be present together or not at all.
-[PRIMARY, [SECONDARY]]           # SECONDARY may only appear if PRIMARY is present.
+[SECTION1, [SECTION2]]           # SECTION2 may only appear if SECTION1 is present.
 SECTION_NAME="option1"|"option2" # Either one or the other literal may be used.
 SECTION_NAME={"asdf"}            # Any subset of characters may be used.
 ```
 
 The `B` flag always represents an option to execute in blocking mode.
 
+When listing the filters a command accepts, the letter which is passed into
+`FILTERS` will be boldened. Like this: zone**f**ile
+
 #### Server
 
 * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
 * `stop()`
 * `reload()`
-* `stats([SECTION], [ITEM], [FLAGS="F"])`
+* `stats([SECTION, [ITEM]], [FLAGS="F"])`
   + `SECTION` stores the module, `ITEM` stores the counter
   + the `F` flag specifies to include 0 counters in server's response
 
@@ -142,13 +145,15 @@ The following commands apply to all zones if `ZONE` is left empty.
 * `zone-refresh([ZONE], [FLAGS="B"])`
 * `zone-retransfer([ZONE], [FLAGS="B"])`
 * `zone-notify([ZONE], [FLAGS="B"])`
-* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
+* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS={"FB"}])`
   + the output**d**ir filter commands that zone(s) be flushed to path stored in the `DATA` section
+  + the `F` flag is required if zonefile synchronization is disabled
 * `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
   + filters
     - the backup**d**ir filter commands that backups be made to path stored in the `DATA` section
     - **z**onefile, **j**ournal, **t**imers, **k**aspdb, keys**o**nly, **c**atalog, **q**uic
     - negative counterparts (eg. no**Z**onefile) are symmetrical and capitalized
+  + the `F` flag allows for an existing backupdir to be overwritten
 * `zone-restore` *analogous to `zone-backup`*
 * `zone-sign([ZONE], [FLAGS="B"])`
 * `zone-validate([ZONE], [FLAGS="B"])`
@@ -168,15 +173,15 @@ Use `@` as `OWNER` if you want to denote `ZONE` itself as the owner.
   + if `ZONE` is left empty all zones are read
 * `zone-begin(ZONE, [FILTERS="b"])`
   + filters: **b**enevolent
-* `zone-commit(ZONE)`
-* `zone-abort(ZONE)`
-* `zone-diff(ZONE)`
-* `zone-get(ZONE, [OWNER], [TYPE])`
-* `zone-set(ZONE, OWNER, [TTL], TYPE, DATA)`
-* `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
-* `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
+* `zone-commit([ZONE])`
+* `zone-abort([ZONE])`
+* `zone-diff([ZONE])`
+* `zone-get([ZONE], [OWNER], [TYPE])`
+* `zone-set([ZONE], OWNER, [TTL], TYPE, DATA)`
+* `zone-unset([ZONE], OWNER, [TYPE, [DATA]])`
+* `zone-purge([ZONE], [FILTERS={ocejktf}], [FLAGS="B"])`
   + filters: **o**rphan, **c**atalog, **e**xpire, **j**ournal, **k**aspdb, **t**imers, zone**f**ile
-* `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
+* `zone-stats([ZONE], [SECTION, [ITEM]], [FLAGS="F"])`
   + `SECTION` stores the module, `ITEM` stores the counter
   + the `F` flag specifies to include 0 counters in server's response
 
@@ -203,7 +208,8 @@ For the following commands:
 * `conf-diff([SECTION, [ID], [ITEM]])`
 * `conf-get([SECTION, [ID], [ITEM]])`
 * `conf-set(SECTION, ID, ITEM, [DATA])`
-* `conf-unset([SECTION, [ID], [ITEM]], [DATA])`
+* `conf-unset([SECTION, [ID], [ITEM], [DATA]])`
+  + `DATA` may only be meaningfully specified if the preceding sections are as well
 
 ### Control usage<a id="control-usage"></a>
 

{libknot-3.3.15.dev0 → libknot-3.3.17.dev0}/README.md

@@ -39,7 +39,7 @@ The module API is stored in `libknot.control`.
 ### Protocol overview<a id="kctl-proto"></a>
 
 Connections are supposed to be short-lived, because maintaining a passive
-connection is costly for the server. Therefore the expected usage of the CTL
+connection is costly for the server. Therefore the expected usage of the control
 interface is to always open a new connection on demand, then close it once it's
 not immediately needed.
 
@@ -59,7 +59,7 @@ then sent along with the next `END` or `BLOCK` unit.
 A unit can optionaly hold data, though this is only meaningful for the `DATA`
 and `EXTRA` types. The data consists of several sections of which usually only
 a few at a time will be present. For example when a unit issuing a `stats`
-command is sent, there is no reason for it to contain an `ERROR` section.
+command is sent, there is no reason for it to contain an `ID` section.
 
 The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 
@@ -67,7 +67,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 | ------------ | ----------------------- | ------------------------------------------------------ |
 | `COMMAND`    | cmd                     | Command name.                                          |
 | `FLAGS`      | flags                   | Command flags.                                         |
-| `ERROR`      | *n/a*                   | Error message. Only sent by the server.                |
+| `ERROR`      | *(n/a)*                 | Error message. Only sent by the server.                |
 | `SECTION`    | section                 | Configuration section name.                            |
 | `ITEM`       | item                    | Configuration item name.                               |
 | `ID`         | identifier              | Configuration item identifier.                         |
@@ -80,7 +80,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 
 ### Commands reference<a id="kctl-cmds"></a>
 
-The following is a reference for the low-level CTL API. In case you're unsure
+The following is a reference for the low-level control API. In case you're unsure
 of the commands' semantics, please consult the
 <a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
 
@@ -93,19 +93,22 @@ cmd-name(SECTION_NAME, [OPT_SECTION])
 
 [OPT_SECTION="literal value"],   # Optional section with fixed expected value.
 [SECTION1, SECTION2]             # Sections must be present together or not at all.
-[PRIMARY, [SECONDARY]]           # SECONDARY may only appear if PRIMARY is present.
+[SECTION1, [SECTION2]]           # SECTION2 may only appear if SECTION1 is present.
 SECTION_NAME="option1"|"option2" # Either one or the other literal may be used.
 SECTION_NAME={"asdf"}            # Any subset of characters may be used.
 ```
 
 The `B` flag always represents an option to execute in blocking mode.
 
+When listing the filters a command accepts, the letter which is passed into
+`FILTERS` will be boldened. Like this: zone**f**ile
+
 #### Server
 
 * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
 * `stop()`
 * `reload()`
-* `stats([SECTION], [ITEM], [FLAGS="F"])`
+* `stats([SECTION, [ITEM]], [FLAGS="F"])`
   + `SECTION` stores the module, `ITEM` stores the counter
   + the `F` flag specifies to include 0 counters in server's response
 
@@ -120,13 +123,15 @@ The following commands apply to all zones if `ZONE` is left empty.
 * `zone-refresh([ZONE], [FLAGS="B"])`
 * `zone-retransfer([ZONE], [FLAGS="B"])`
 * `zone-notify([ZONE], [FLAGS="B"])`
-* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
+* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS={"FB"}])`
   + the output**d**ir filter commands that zone(s) be flushed to path stored in the `DATA` section
+  + the `F` flag is required if zonefile synchronization is disabled
 * `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
   + filters
     - the backup**d**ir filter commands that backups be made to path stored in the `DATA` section
     - **z**onefile, **j**ournal, **t**imers, **k**aspdb, keys**o**nly, **c**atalog, **q**uic
     - negative counterparts (eg. no**Z**onefile) are symmetrical and capitalized
+  + the `F` flag allows for an existing backupdir to be overwritten
 * `zone-restore` *analogous to `zone-backup`*
 * `zone-sign([ZONE], [FLAGS="B"])`
 * `zone-validate([ZONE], [FLAGS="B"])`
@@ -146,15 +151,15 @@ Use `@` as `OWNER` if you want to denote `ZONE` itself as the owner.
   + if `ZONE` is left empty all zones are read
 * `zone-begin(ZONE, [FILTERS="b"])`
   + filters: **b**enevolent
-* `zone-commit(ZONE)`
-* `zone-abort(ZONE)`
-* `zone-diff(ZONE)`
-* `zone-get(ZONE, [OWNER], [TYPE])`
-* `zone-set(ZONE, OWNER, [TTL], TYPE, DATA)`
-* `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
-* `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
+* `zone-commit([ZONE])`
+* `zone-abort([ZONE])`
+* `zone-diff([ZONE])`
+* `zone-get([ZONE], [OWNER], [TYPE])`
+* `zone-set([ZONE], OWNER, [TTL], TYPE, DATA)`
+* `zone-unset([ZONE], OWNER, [TYPE, [DATA]])`
+* `zone-purge([ZONE], [FILTERS={ocejktf}], [FLAGS="B"])`
   + filters: **o**rphan, **c**atalog, **e**xpire, **j**ournal, **k**aspdb, **t**imers, zone**f**ile
-* `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
+* `zone-stats([ZONE], [SECTION, [ITEM]], [FLAGS="F"])`
   + `SECTION` stores the module, `ITEM` stores the counter
   + the `F` flag specifies to include 0 counters in server's response
 
@@ -181,7 +186,8 @@ For the following commands:
 * `conf-diff([SECTION, [ID], [ITEM]])`
 * `conf-get([SECTION, [ID], [ITEM]])`
 * `conf-set(SECTION, ID, ITEM, [DATA])`
-* `conf-unset([SECTION, [ID], [ITEM]], [DATA])`
+* `conf-unset([SECTION, [ID], [ITEM], [DATA]])`
+  + `DATA` may only be meaningfully specified if the preceding sections are as well
 
 ### Control usage<a id="control-usage"></a>
 

{libknot-3.3.15.dev0 → libknot-3.3.17.dev0}/libknot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libknot
-Version: 3.3.15.dev0
+Version: 3.3.17.dev0
 Summary: Python bindings for libknot
 Home-page: https://gitlab.nic.cz/knot/knot-dns/-/tree/master/python/libknot
 Author: CZ.NIC, z.s.p.o.
@@ -61,7 +61,7 @@ The module API is stored in `libknot.control`.
 ### Protocol overview<a id="kctl-proto"></a>
 
 Connections are supposed to be short-lived, because maintaining a passive
-connection is costly for the server. Therefore the expected usage of the CTL
+connection is costly for the server. Therefore the expected usage of the control
 interface is to always open a new connection on demand, then close it once it's
 not immediately needed.
 
@@ -81,7 +81,7 @@ then sent along with the next `END` or `BLOCK` unit.
 A unit can optionaly hold data, though this is only meaningful for the `DATA`
 and `EXTRA` types. The data consists of several sections of which usually only
 a few at a time will be present. For example when a unit issuing a `stats`
-command is sent, there is no reason for it to contain an `ERROR` section.
+command is sent, there is no reason for it to contain an `ID` section.
 
 The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 
@@ -89,7 +89,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 | ------------ | ----------------------- | ------------------------------------------------------ |
 | `COMMAND`    | cmd                     | Command name.                                          |
 | `FLAGS`      | flags                   | Command flags.                                         |
-| `ERROR`      | *n/a*                   | Error message. Only sent by the server.                |
+| `ERROR`      | *(n/a)*                 | Error message. Only sent by the server.                |
 | `SECTION`    | section                 | Configuration section name.                            |
 | `ITEM`       | item                    | Configuration item name.                               |
 | `ID`         | identifier              | Configuration item identifier.                         |
@@ -102,7 +102,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 
 ### Commands reference<a id="kctl-cmds"></a>
 
-The following is a reference for the low-level CTL API. In case you're unsure
+The following is a reference for the low-level control API. In case you're unsure
 of the commands' semantics, please consult the
 <a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
 
@@ -115,19 +115,22 @@ cmd-name(SECTION_NAME, [OPT_SECTION])
 
 [OPT_SECTION="literal value"],   # Optional section with fixed expected value.
 [SECTION1, SECTION2]             # Sections must be present together or not at all.
-[PRIMARY, [SECONDARY]]           # SECONDARY may only appear if PRIMARY is present.
+[SECTION1, [SECTION2]]           # SECTION2 may only appear if SECTION1 is present.
 SECTION_NAME="option1"|"option2" # Either one or the other literal may be used.
 SECTION_NAME={"asdf"}            # Any subset of characters may be used.
 ```
 
 The `B` flag always represents an option to execute in blocking mode.
 
+When listing the filters a command accepts, the letter which is passed into
+`FILTERS` will be boldened. Like this: zone**f**ile
+
 #### Server
 
 * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
 * `stop()`
 * `reload()`
-* `stats([SECTION], [ITEM], [FLAGS="F"])`
+* `stats([SECTION, [ITEM]], [FLAGS="F"])`
   + `SECTION` stores the module, `ITEM` stores the counter
   + the `F` flag specifies to include 0 counters in server's response
 
@@ -142,13 +145,15 @@ The following commands apply to all zones if `ZONE` is left empty.
 * `zone-refresh([ZONE], [FLAGS="B"])`
 * `zone-retransfer([ZONE], [FLAGS="B"])`
 * `zone-notify([ZONE], [FLAGS="B"])`
-* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
+* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS={"FB"}])`
   + the output**d**ir filter commands that zone(s) be flushed to path stored in the `DATA` section
+  + the `F` flag is required if zonefile synchronization is disabled
 * `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
   + filters
     - the backup**d**ir filter commands that backups be made to path stored in the `DATA` section
     - **z**onefile, **j**ournal, **t**imers, **k**aspdb, keys**o**nly, **c**atalog, **q**uic
     - negative counterparts (eg. no**Z**onefile) are symmetrical and capitalized
+  + the `F` flag allows for an existing backupdir to be overwritten
 * `zone-restore` *analogous to `zone-backup`*
 * `zone-sign([ZONE], [FLAGS="B"])`
 * `zone-validate([ZONE], [FLAGS="B"])`
@@ -168,15 +173,15 @@ Use `@` as `OWNER` if you want to denote `ZONE` itself as the owner.
   + if `ZONE` is left empty all zones are read
 * `zone-begin(ZONE, [FILTERS="b"])`
   + filters: **b**enevolent
-* `zone-commit(ZONE)`
-* `zone-abort(ZONE)`
-* `zone-diff(ZONE)`
-* `zone-get(ZONE, [OWNER], [TYPE])`
-* `zone-set(ZONE, OWNER, [TTL], TYPE, DATA)`
-* `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
-* `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
+* `zone-commit([ZONE])`
+* `zone-abort([ZONE])`
+* `zone-diff([ZONE])`
+* `zone-get([ZONE], [OWNER], [TYPE])`
+* `zone-set([ZONE], OWNER, [TTL], TYPE, DATA)`
+* `zone-unset([ZONE], OWNER, [TYPE, [DATA]])`
+* `zone-purge([ZONE], [FILTERS={ocejktf}], [FLAGS="B"])`
   + filters: **o**rphan, **c**atalog, **e**xpire, **j**ournal, **k**aspdb, **t**imers, zone**f**ile
-* `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
+* `zone-stats([ZONE], [SECTION, [ITEM]], [FLAGS="F"])`
   + `SECTION` stores the module, `ITEM` stores the counter
   + the `F` flag specifies to include 0 counters in server's response
 
@@ -203,7 +208,8 @@ For the following commands:
 * `conf-diff([SECTION, [ID], [ITEM]])`
 * `conf-get([SECTION, [ID], [ITEM]])`
 * `conf-set(SECTION, ID, ITEM, [DATA])`
-* `conf-unset([SECTION, [ID], [ITEM]], [DATA])`
+* `conf-unset([SECTION, [ID], [ITEM], [DATA]])`
+  + `DATA` may only be meaningfully specified if the preceding sections are as well
 
 ### Control usage<a id="control-usage"></a>
 

{libknot-3.3.15.dev0 → libknot-3.3.17.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "libknot"
-version = "3.3.15dev"
+version = "3.3.17dev"
 description = "Python bindings for libknot"
 readme = "README.md"
 requires-python = ">=3.5"

{libknot-3.3.15.dev0 → libknot-3.3.17.dev0}/setup.py

@@ -7,7 +7,7 @@ if p.exists():
 
 setuptools.setup(
     name='libknot',
-    version='3.3.15dev',
+    version='3.3.17dev',
     description='Python bindings for libknot',
     long_description=long_description,
     long_description_content_type="text/markdown",