libknot 3.3.16.dev0__tar.gz → 3.3.17.dev0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: libknot
3
- Version: 3.3.16.dev0
3
+ Version: 3.3.17.dev0
4
4
  Summary: Python bindings for libknot
5
5
  Home-page: https://gitlab.nic.cz/knot/knot-dns/-/tree/master/python/libknot
6
6
  Author: CZ.NIC, z.s.p.o.
@@ -61,7 +61,7 @@ The module API is stored in `libknot.control`.
61
61
  ### Protocol overview<a id="kctl-proto"></a>
62
62
 
63
63
  Connections are supposed to be short-lived, because maintaining a passive
64
- connection is costly for the server. Therefore the expected usage of the CTL
64
+ connection is costly for the server. Therefore the expected usage of the control
65
65
  interface is to always open a new connection on demand, then close it once it's
66
66
  not immediately needed.
67
67
 
@@ -81,7 +81,7 @@ then sent along with the next `END` or `BLOCK` unit.
81
81
  A unit can optionaly hold data, though this is only meaningful for the `DATA`
82
82
  and `EXTRA` types. The data consists of several sections of which usually only
83
83
  a few at a time will be present. For example when a unit issuing a `stats`
84
- command is sent, there is no reason for it to contain an `ERROR` section.
84
+ command is sent, there is no reason for it to contain an `ID` section.
85
85
 
86
86
  The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
87
87
 
@@ -89,7 +89,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
89
89
  | ------------ | ----------------------- | ------------------------------------------------------ |
90
90
  | `COMMAND` | cmd | Command name. |
91
91
  | `FLAGS` | flags | Command flags. |
92
- | `ERROR` | *n/a* | Error message. Only sent by the server. |
92
+ | `ERROR` | *(n/a)* | Error message. Only sent by the server. |
93
93
  | `SECTION` | section | Configuration section name. |
94
94
  | `ITEM` | item | Configuration item name. |
95
95
  | `ID` | identifier | Configuration item identifier. |
@@ -102,7 +102,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
102
102
 
103
103
  ### Commands reference<a id="kctl-cmds"></a>
104
104
 
105
- The following is a reference for the low-level CTL API. In case you're unsure
105
+ The following is a reference for the low-level control API. In case you're unsure
106
106
  of the commands' semantics, please consult the
107
107
  <a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
108
108
 
@@ -115,7 +115,7 @@ cmd-name(SECTION_NAME, [OPT_SECTION])
115
115
 
116
116
  [OPT_SECTION="literal value"], # Optional section with fixed expected value.
117
117
  [SECTION1, SECTION2] # Sections must be present together or not at all.
118
- [PRIMARY, [SECONDARY]] # SECONDARY may only appear if PRIMARY is present.
118
+ [SECTION1, [SECTION2]] # SECTION2 may only appear if SECTION1 is present.
119
119
  SECTION_NAME="option1"|"option2" # Either one or the other literal may be used.
120
120
  SECTION_NAME={"asdf"} # Any subset of characters may be used.
121
121
  ```
@@ -130,7 +130,7 @@ When listing the filters a command accepts, the letter which is passed into
130
130
  * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
131
131
  * `stop()`
132
132
  * `reload()`
133
- * `stats([SECTION], [ITEM], [FLAGS="F"])`
133
+ * `stats([SECTION, [ITEM]], [FLAGS="F"])`
134
134
  + `SECTION` stores the module, `ITEM` stores the counter
135
135
  + the `F` flag specifies to include 0 counters in server's response
136
136
 
@@ -145,13 +145,15 @@ The following commands apply to all zones if `ZONE` is left empty.
145
145
  * `zone-refresh([ZONE], [FLAGS="B"])`
146
146
  * `zone-retransfer([ZONE], [FLAGS="B"])`
147
147
  * `zone-notify([ZONE], [FLAGS="B"])`
148
- * `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
148
+ * `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS={"FB"}])`
149
149
  + the output**d**ir filter commands that zone(s) be flushed to path stored in the `DATA` section
150
+ + the `F` flag is required if zonefile synchronization is disabled
150
151
  * `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
151
152
  + filters
152
153
  - the backup**d**ir filter commands that backups be made to path stored in the `DATA` section
153
154
  - **z**onefile, **j**ournal, **t**imers, **k**aspdb, keys**o**nly, **c**atalog, **q**uic
154
155
  - negative counterparts (eg. no**Z**onefile) are symmetrical and capitalized
156
+ + the `F` flag allows for an existing backupdir to be overwritten
155
157
  * `zone-restore` *analogous to `zone-backup`*
156
158
  * `zone-sign([ZONE], [FLAGS="B"])`
157
159
  * `zone-validate([ZONE], [FLAGS="B"])`
@@ -171,15 +173,15 @@ Use `@` as `OWNER` if you want to denote `ZONE` itself as the owner.
171
173
  + if `ZONE` is left empty all zones are read
172
174
  * `zone-begin(ZONE, [FILTERS="b"])`
173
175
  + filters: **b**enevolent
174
- * `zone-commit(ZONE)`
175
- * `zone-abort(ZONE)`
176
- * `zone-diff(ZONE)`
177
- * `zone-get(ZONE, [OWNER], [TYPE])`
178
- * `zone-set(ZONE, OWNER, [TTL], TYPE, DATA)`
179
- * `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
180
- * `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
176
+ * `zone-commit([ZONE])`
177
+ * `zone-abort([ZONE])`
178
+ * `zone-diff([ZONE])`
179
+ * `zone-get([ZONE], [OWNER], [TYPE])`
180
+ * `zone-set([ZONE], OWNER, [TTL], TYPE, DATA)`
181
+ * `zone-unset([ZONE], OWNER, [TYPE, [DATA]])`
182
+ * `zone-purge([ZONE], [FILTERS={ocejktf}], [FLAGS="B"])`
181
183
  + filters: **o**rphan, **c**atalog, **e**xpire, **j**ournal, **k**aspdb, **t**imers, zone**f**ile
182
- * `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
184
+ * `zone-stats([ZONE], [SECTION, [ITEM]], [FLAGS="F"])`
183
185
  + `SECTION` stores the module, `ITEM` stores the counter
184
186
  + the `F` flag specifies to include 0 counters in server's response
185
187
 
@@ -206,7 +208,8 @@ For the following commands:
206
208
  * `conf-diff([SECTION, [ID], [ITEM]])`
207
209
  * `conf-get([SECTION, [ID], [ITEM]])`
208
210
  * `conf-set(SECTION, ID, ITEM, [DATA])`
209
- * `conf-unset([SECTION, [ID], [ITEM]], [DATA])`
211
+ * `conf-unset([SECTION, [ID], [ITEM], [DATA]])`
212
+ + `DATA` may only be meaningfully specified if the preceding sections are as well
210
213
 
211
214
  ### Control usage<a id="control-usage"></a>
212
215
 
@@ -39,7 +39,7 @@ The module API is stored in `libknot.control`.
39
39
  ### Protocol overview<a id="kctl-proto"></a>
40
40
 
41
41
  Connections are supposed to be short-lived, because maintaining a passive
42
- connection is costly for the server. Therefore the expected usage of the CTL
42
+ connection is costly for the server. Therefore the expected usage of the control
43
43
  interface is to always open a new connection on demand, then close it once it's
44
44
  not immediately needed.
45
45
 
@@ -59,7 +59,7 @@ then sent along with the next `END` or `BLOCK` unit.
59
59
  A unit can optionaly hold data, though this is only meaningful for the `DATA`
60
60
  and `EXTRA` types. The data consists of several sections of which usually only
61
61
  a few at a time will be present. For example when a unit issuing a `stats`
62
- command is sent, there is no reason for it to contain an `ERROR` section.
62
+ command is sent, there is no reason for it to contain an `ID` section.
63
63
 
64
64
  The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
65
65
 
@@ -67,7 +67,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
67
67
  | ------------ | ----------------------- | ------------------------------------------------------ |
68
68
  | `COMMAND` | cmd | Command name. |
69
69
  | `FLAGS` | flags | Command flags. |
70
- | `ERROR` | *n/a* | Error message. Only sent by the server. |
70
+ | `ERROR` | *(n/a)* | Error message. Only sent by the server. |
71
71
  | `SECTION` | section | Configuration section name. |
72
72
  | `ITEM` | item | Configuration item name. |
73
73
  | `ID` | identifier | Configuration item identifier. |
@@ -80,7 +80,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
80
80
 
81
81
  ### Commands reference<a id="kctl-cmds"></a>
82
82
 
83
- The following is a reference for the low-level CTL API. In case you're unsure
83
+ The following is a reference for the low-level control API. In case you're unsure
84
84
  of the commands' semantics, please consult the
85
85
  <a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
86
86
 
@@ -93,7 +93,7 @@ cmd-name(SECTION_NAME, [OPT_SECTION])
93
93
 
94
94
  [OPT_SECTION="literal value"], # Optional section with fixed expected value.
95
95
  [SECTION1, SECTION2] # Sections must be present together or not at all.
96
- [PRIMARY, [SECONDARY]] # SECONDARY may only appear if PRIMARY is present.
96
+ [SECTION1, [SECTION2]] # SECTION2 may only appear if SECTION1 is present.
97
97
  SECTION_NAME="option1"|"option2" # Either one or the other literal may be used.
98
98
  SECTION_NAME={"asdf"} # Any subset of characters may be used.
99
99
  ```
@@ -108,7 +108,7 @@ When listing the filters a command accepts, the letter which is passed into
108
108
  * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
109
109
  * `stop()`
110
110
  * `reload()`
111
- * `stats([SECTION], [ITEM], [FLAGS="F"])`
111
+ * `stats([SECTION, [ITEM]], [FLAGS="F"])`
112
112
  + `SECTION` stores the module, `ITEM` stores the counter
113
113
  + the `F` flag specifies to include 0 counters in server's response
114
114
 
@@ -123,13 +123,15 @@ The following commands apply to all zones if `ZONE` is left empty.
123
123
  * `zone-refresh([ZONE], [FLAGS="B"])`
124
124
  * `zone-retransfer([ZONE], [FLAGS="B"])`
125
125
  * `zone-notify([ZONE], [FLAGS="B"])`
126
- * `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
126
+ * `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS={"FB"}])`
127
127
  + the output**d**ir filter commands that zone(s) be flushed to path stored in the `DATA` section
128
+ + the `F` flag is required if zonefile synchronization is disabled
128
129
  * `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
129
130
  + filters
130
131
  - the backup**d**ir filter commands that backups be made to path stored in the `DATA` section
131
132
  - **z**onefile, **j**ournal, **t**imers, **k**aspdb, keys**o**nly, **c**atalog, **q**uic
132
133
  - negative counterparts (eg. no**Z**onefile) are symmetrical and capitalized
134
+ + the `F` flag allows for an existing backupdir to be overwritten
133
135
  * `zone-restore` *analogous to `zone-backup`*
134
136
  * `zone-sign([ZONE], [FLAGS="B"])`
135
137
  * `zone-validate([ZONE], [FLAGS="B"])`
@@ -149,15 +151,15 @@ Use `@` as `OWNER` if you want to denote `ZONE` itself as the owner.
149
151
  + if `ZONE` is left empty all zones are read
150
152
  * `zone-begin(ZONE, [FILTERS="b"])`
151
153
  + filters: **b**enevolent
152
- * `zone-commit(ZONE)`
153
- * `zone-abort(ZONE)`
154
- * `zone-diff(ZONE)`
155
- * `zone-get(ZONE, [OWNER], [TYPE])`
156
- * `zone-set(ZONE, OWNER, [TTL], TYPE, DATA)`
157
- * `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
158
- * `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
154
+ * `zone-commit([ZONE])`
155
+ * `zone-abort([ZONE])`
156
+ * `zone-diff([ZONE])`
157
+ * `zone-get([ZONE], [OWNER], [TYPE])`
158
+ * `zone-set([ZONE], OWNER, [TTL], TYPE, DATA)`
159
+ * `zone-unset([ZONE], OWNER, [TYPE, [DATA]])`
160
+ * `zone-purge([ZONE], [FILTERS={ocejktf}], [FLAGS="B"])`
159
161
  + filters: **o**rphan, **c**atalog, **e**xpire, **j**ournal, **k**aspdb, **t**imers, zone**f**ile
160
- * `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
162
+ * `zone-stats([ZONE], [SECTION, [ITEM]], [FLAGS="F"])`
161
163
  + `SECTION` stores the module, `ITEM` stores the counter
162
164
  + the `F` flag specifies to include 0 counters in server's response
163
165
 
@@ -184,7 +186,8 @@ For the following commands:
184
186
  * `conf-diff([SECTION, [ID], [ITEM]])`
185
187
  * `conf-get([SECTION, [ID], [ITEM]])`
186
188
  * `conf-set(SECTION, ID, ITEM, [DATA])`
187
- * `conf-unset([SECTION, [ID], [ITEM]], [DATA])`
189
+ * `conf-unset([SECTION, [ID], [ITEM], [DATA]])`
190
+ + `DATA` may only be meaningfully specified if the preceding sections are as well
188
191
 
189
192
  ### Control usage<a id="control-usage"></a>
190
193
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: libknot
3
- Version: 3.3.16.dev0
3
+ Version: 3.3.17.dev0
4
4
  Summary: Python bindings for libknot
5
5
  Home-page: https://gitlab.nic.cz/knot/knot-dns/-/tree/master/python/libknot
6
6
  Author: CZ.NIC, z.s.p.o.
@@ -61,7 +61,7 @@ The module API is stored in `libknot.control`.
61
61
  ### Protocol overview<a id="kctl-proto"></a>
62
62
 
63
63
  Connections are supposed to be short-lived, because maintaining a passive
64
- connection is costly for the server. Therefore the expected usage of the CTL
64
+ connection is costly for the server. Therefore the expected usage of the control
65
65
  interface is to always open a new connection on demand, then close it once it's
66
66
  not immediately needed.
67
67
 
@@ -81,7 +81,7 @@ then sent along with the next `END` or `BLOCK` unit.
81
81
  A unit can optionaly hold data, though this is only meaningful for the `DATA`
82
82
  and `EXTRA` types. The data consists of several sections of which usually only
83
83
  a few at a time will be present. For example when a unit issuing a `stats`
84
- command is sent, there is no reason for it to contain an `ERROR` section.
84
+ command is sent, there is no reason for it to contain an `ID` section.
85
85
 
86
86
  The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
87
87
 
@@ -89,7 +89,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
89
89
  | ------------ | ----------------------- | ------------------------------------------------------ |
90
90
  | `COMMAND` | cmd | Command name. |
91
91
  | `FLAGS` | flags | Command flags. |
92
- | `ERROR` | *n/a* | Error message. Only sent by the server. |
92
+ | `ERROR` | *(n/a)* | Error message. Only sent by the server. |
93
93
  | `SECTION` | section | Configuration section name. |
94
94
  | `ITEM` | item | Configuration item name. |
95
95
  | `ID` | identifier | Configuration item identifier. |
@@ -102,7 +102,7 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
102
102
 
103
103
  ### Commands reference<a id="kctl-cmds"></a>
104
104
 
105
- The following is a reference for the low-level CTL API. In case you're unsure
105
+ The following is a reference for the low-level control API. In case you're unsure
106
106
  of the commands' semantics, please consult the
107
107
  <a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
108
108
 
@@ -115,7 +115,7 @@ cmd-name(SECTION_NAME, [OPT_SECTION])
115
115
 
116
116
  [OPT_SECTION="literal value"], # Optional section with fixed expected value.
117
117
  [SECTION1, SECTION2] # Sections must be present together or not at all.
118
- [PRIMARY, [SECONDARY]] # SECONDARY may only appear if PRIMARY is present.
118
+ [SECTION1, [SECTION2]] # SECTION2 may only appear if SECTION1 is present.
119
119
  SECTION_NAME="option1"|"option2" # Either one or the other literal may be used.
120
120
  SECTION_NAME={"asdf"} # Any subset of characters may be used.
121
121
  ```
@@ -130,7 +130,7 @@ When listing the filters a command accepts, the letter which is passed into
130
130
  * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
131
131
  * `stop()`
132
132
  * `reload()`
133
- * `stats([SECTION], [ITEM], [FLAGS="F"])`
133
+ * `stats([SECTION, [ITEM]], [FLAGS="F"])`
134
134
  + `SECTION` stores the module, `ITEM` stores the counter
135
135
  + the `F` flag specifies to include 0 counters in server's response
136
136
 
@@ -145,13 +145,15 @@ The following commands apply to all zones if `ZONE` is left empty.
145
145
  * `zone-refresh([ZONE], [FLAGS="B"])`
146
146
  * `zone-retransfer([ZONE], [FLAGS="B"])`
147
147
  * `zone-notify([ZONE], [FLAGS="B"])`
148
- * `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
148
+ * `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS={"FB"}])`
149
149
  + the output**d**ir filter commands that zone(s) be flushed to path stored in the `DATA` section
150
+ + the `F` flag is required if zonefile synchronization is disabled
150
151
  * `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
151
152
  + filters
152
153
  - the backup**d**ir filter commands that backups be made to path stored in the `DATA` section
153
154
  - **z**onefile, **j**ournal, **t**imers, **k**aspdb, keys**o**nly, **c**atalog, **q**uic
154
155
  - negative counterparts (eg. no**Z**onefile) are symmetrical and capitalized
156
+ + the `F` flag allows for an existing backupdir to be overwritten
155
157
  * `zone-restore` *analogous to `zone-backup`*
156
158
  * `zone-sign([ZONE], [FLAGS="B"])`
157
159
  * `zone-validate([ZONE], [FLAGS="B"])`
@@ -171,15 +173,15 @@ Use `@` as `OWNER` if you want to denote `ZONE` itself as the owner.
171
173
  + if `ZONE` is left empty all zones are read
172
174
  * `zone-begin(ZONE, [FILTERS="b"])`
173
175
  + filters: **b**enevolent
174
- * `zone-commit(ZONE)`
175
- * `zone-abort(ZONE)`
176
- * `zone-diff(ZONE)`
177
- * `zone-get(ZONE, [OWNER], [TYPE])`
178
- * `zone-set(ZONE, OWNER, [TTL], TYPE, DATA)`
179
- * `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
180
- * `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
176
+ * `zone-commit([ZONE])`
177
+ * `zone-abort([ZONE])`
178
+ * `zone-diff([ZONE])`
179
+ * `zone-get([ZONE], [OWNER], [TYPE])`
180
+ * `zone-set([ZONE], OWNER, [TTL], TYPE, DATA)`
181
+ * `zone-unset([ZONE], OWNER, [TYPE, [DATA]])`
182
+ * `zone-purge([ZONE], [FILTERS={ocejktf}], [FLAGS="B"])`
181
183
  + filters: **o**rphan, **c**atalog, **e**xpire, **j**ournal, **k**aspdb, **t**imers, zone**f**ile
182
- * `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
184
+ * `zone-stats([ZONE], [SECTION, [ITEM]], [FLAGS="F"])`
183
185
  + `SECTION` stores the module, `ITEM` stores the counter
184
186
  + the `F` flag specifies to include 0 counters in server's response
185
187
 
@@ -206,7 +208,8 @@ For the following commands:
206
208
  * `conf-diff([SECTION, [ID], [ITEM]])`
207
209
  * `conf-get([SECTION, [ID], [ITEM]])`
208
210
  * `conf-set(SECTION, ID, ITEM, [DATA])`
209
- * `conf-unset([SECTION, [ID], [ITEM]], [DATA])`
211
+ * `conf-unset([SECTION, [ID], [ITEM], [DATA]])`
212
+ + `DATA` may only be meaningfully specified if the preceding sections are as well
210
213
 
211
214
  ### Control usage<a id="control-usage"></a>
212
215
 
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "libknot"
7
- version = "3.3.16dev"
7
+ version = "3.3.17dev"
8
8
  description = "Python bindings for libknot"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.5"
@@ -7,7 +7,7 @@ if p.exists():
7
7
 
8
8
  setuptools.setup(
9
9
  name='libknot',
10
- version='3.3.16dev',
10
+ version='3.3.17dev',
11
11
  description='Python bindings for libknot',
12
12
  long_description=long_description,
13
13
  long_description_content_type="text/markdown",
File without changes