Skip to content

Commit 54fad6d

Browse files
github-actions[bot]daniil-quix
github-actions[bot]
and
daniil-quix
authored
Update documentation (#909)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent 3cda236 commit 54fad6d

File tree

3 files changed

+67
-75
lines changed

3 files changed

+67
-75
lines changed

‎docs/api-reference/dataframe.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -277,14 +277,12 @@ Default - `False`.
277277
#### StreamingDataFrame.group\_by
278278

279279
```python
280-
def group_by(
281-
key: Union[str, Callable[[Any], Any]],
282-
name: Optional[str] = None,
283-
value_deserializer: Optional[DeserializerType] = "json",
284-
key_deserializer: Optional[DeserializerType] = "json",
285-
value_serializer: Optional[SerializerType] = "json",
286-
key_serializer: Optional[SerializerType] = "json"
287-
) -> "StreamingDataFrame"
280+
def group_by(key: Union[str, Callable[[Any], Any]],
281+
name: Optional[str] = None,
282+
value_deserializer: DeserializerType = "json",
283+
key_deserializer: DeserializerType = "json",
284+
value_serializer: SerializerType = "json",
285+
key_serializer: SerializerType = "json") -> "StreamingDataFrame"
288286
```
289287

290288
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L525)

‎docs/api-reference/quixstreams.md‎

Lines changed: 34 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1175,14 +1175,12 @@ Default - `False`.
11751175
#### StreamingDataFrame.group\_by
11761176

11771177
```python
1178-
def group_by(
1179-
key: Union[str, Callable[[Any], Any]],
1180-
name: Optional[str] = None,
1181-
value_deserializer: Optional[DeserializerType] = "json",
1182-
key_deserializer: Optional[DeserializerType] = "json",
1183-
value_serializer: Optional[SerializerType] = "json",
1184-
key_serializer: Optional[SerializerType] = "json"
1185-
) -> "StreamingDataFrame"
1178+
def group_by(key: Union[str, Callable[[Any], Any]],
1179+
name: Optional[str] = None,
1180+
value_deserializer: DeserializerType = "json",
1181+
key_deserializer: DeserializerType = "json",
1182+
value_serializer: SerializerType = "json",
1183+
key_serializer: SerializerType = "json") -> "StreamingDataFrame"
11861184
```
11871185

11881186
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L525)
@@ -7764,7 +7762,7 @@ then this property must be set to True until all old consumers have been upgrade
77647762
class IgnoreMessage(exceptions.QuixException)
77657763
```
77667764

7767-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/serializers/exceptions.py#L54)
7765+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/serializers/exceptions.py#L46)
77687766

77697767
Raise this exception from Deserializer.__call__ in order to ignore the processing
77707768
of the particular message.
@@ -8497,7 +8495,7 @@ a list of (key, value) tuples.
84978495
class TopicConfig()
84988496
```
84998497

8500-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L45)
8498+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L41)
85018499

85028500
Represents all kafka-level configuration for a kafka topic.
85038501

@@ -8511,7 +8509,7 @@ Generally used by Topic and any topic creation procedures.
85118509
class Topic()
85128510
```
85138511

8514-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L92)
8512+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L98)
85158513

85168514
A definition of a Kafka topic.
85178515

@@ -8524,19 +8522,18 @@ instance.
85248522
#### Topic.\_\_init\_\_
85258523

85268524
```python
8527-
def __init__(
8528-
name: str,
8529-
topic_type: TopicType = TopicType.REGULAR,
8530-
create_config: Optional[TopicConfig] = None,
8531-
value_deserializer: Optional[DeserializerType] = None,
8532-
key_deserializer: Optional[DeserializerType] = BytesDeserializer(),
8533-
value_serializer: Optional[SerializerType] = None,
8534-
key_serializer: Optional[SerializerType] = BytesSerializer(),
8535-
timestamp_extractor: Optional[TimestampExtractor] = None,
8536-
quix_name: str = "")
8525+
def __init__(name: str,
8526+
topic_type: TopicType = TopicType.REGULAR,
8527+
create_config: Optional[TopicConfig] = None,
8528+
value_deserializer: DeserializerType = "json",
8529+
key_deserializer: DeserializerType = "bytes",
8530+
value_serializer: SerializerType = "json",
8531+
key_serializer: SerializerType = "bytes",
8532+
timestamp_extractor: Optional[TimestampExtractor] = None,
8533+
quix_name: str = "")
85378534
```
85388535

8539-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L101)
8536+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L107)
85408537

85418538
**Arguments**:
85428539

@@ -8566,7 +8563,7 @@ It is set only by `QuixTopicManager`.
85668563
def create_config() -> Optional[TopicConfig]
85678564
```
85688565

8569-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L161)
8566+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L167)
85708567

85718568
A config to create the topic
85728569

@@ -8579,7 +8576,7 @@ A config to create the topic
85798576
def broker_config() -> TopicConfig
85808577
```
85818578

8582-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L172)
8579+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L178)
85838580

85848581
A topic config obtained from the Kafka broker
85858582

@@ -8591,7 +8588,7 @@ A topic config obtained from the Kafka broker
85918588
def row_serialize(row: Row, key: Any) -> KafkaMessage
85928589
```
85938590

8594-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L198)
8591+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L204)
85958592

85968593
Serialize Row to a Kafka message structure
85978594

@@ -8614,7 +8611,7 @@ def row_deserialize(
86148611
) -> Union[Row, List[Row], None]
86158612
```
86168613

8617-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L238)
8614+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L235)
86188615

86198616
Deserialize incoming Kafka message to a Row.
86208617

@@ -8759,10 +8756,10 @@ a TopicConfig object
87598756

87608757
```python
87618758
def topic(name: str,
8762-
value_deserializer: Optional[DeserializerType] = None,
8763-
key_deserializer: Optional[DeserializerType] = "bytes",
8764-
value_serializer: Optional[SerializerType] = None,
8765-
key_serializer: Optional[SerializerType] = "bytes",
8759+
value_deserializer: DeserializerType = "json",
8760+
key_deserializer: DeserializerType = "bytes",
8761+
value_serializer: SerializerType = "json",
8762+
key_serializer: SerializerType = "bytes",
87668763
create_config: Optional[TopicConfig] = None,
87678764
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
87688765
```
@@ -8811,14 +8808,13 @@ The topic name and config can be updated by the topic manager.
88118808
#### TopicManager.repartition\_topic
88128809

88138810
```python
8814-
def repartition_topic(
8815-
operation: str,
8816-
stream_id: str,
8817-
config: TopicConfig,
8818-
value_deserializer: Optional[DeserializerType] = "json",
8819-
key_deserializer: Optional[DeserializerType] = "json",
8820-
value_serializer: Optional[SerializerType] = "json",
8821-
key_serializer: Optional[SerializerType] = "json") -> Topic
8811+
def repartition_topic(operation: str,
8812+
stream_id: str,
8813+
config: TopicConfig,
8814+
value_deserializer: DeserializerType = "json",
8815+
key_deserializer: DeserializerType = "json",
8816+
value_serializer: SerializerType = "json",
8817+
key_serializer: SerializerType = "json") -> Topic
88228818
```
88238819

88248820
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L202)

‎docs/api-reference/topics.md‎

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ fail (it ignores issues for a topic already existing).
142142
class TopicConfig()
143143
```
144144

145-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L45)
145+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L41)
146146

147147
Represents all kafka-level configuration for a kafka topic.
148148

@@ -156,7 +156,7 @@ Generally used by Topic and any topic creation procedures.
156156
class Topic()
157157
```
158158

159-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L92)
159+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L98)
160160

161161
A definition of a Kafka topic.
162162

@@ -171,19 +171,18 @@ instance.
171171
#### Topic.\_\_init\_\_
172172

173173
```python
174-
def __init__(
175-
name: str,
176-
topic_type: TopicType = TopicType.REGULAR,
177-
create_config: Optional[TopicConfig] = None,
178-
value_deserializer: Optional[DeserializerType] = None,
179-
key_deserializer: Optional[DeserializerType] = BytesDeserializer(),
180-
value_serializer: Optional[SerializerType] = None,
181-
key_serializer: Optional[SerializerType] = BytesSerializer(),
182-
timestamp_extractor: Optional[TimestampExtractor] = None,
183-
quix_name: str = "")
174+
def __init__(name: str,
175+
topic_type: TopicType = TopicType.REGULAR,
176+
create_config: Optional[TopicConfig] = None,
177+
value_deserializer: DeserializerType = "json",
178+
key_deserializer: DeserializerType = "bytes",
179+
value_serializer: SerializerType = "json",
180+
key_serializer: SerializerType = "bytes",
181+
timestamp_extractor: Optional[TimestampExtractor] = None,
182+
quix_name: str = "")
184183
```
185184

186-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L101)
185+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L107)
187186

188187

189188
<br>
@@ -217,7 +216,7 @@ It is set only by `QuixTopicManager`.
217216
def create_config() -> Optional[TopicConfig]
218217
```
219218

220-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L161)
219+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L167)
221220

222221
A config to create the topic
223222

@@ -232,7 +231,7 @@ A config to create the topic
232231
def broker_config() -> TopicConfig
233232
```
234233

235-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L172)
234+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L178)
236235

237236
A topic config obtained from the Kafka broker
238237

@@ -246,7 +245,7 @@ A topic config obtained from the Kafka broker
246245
def row_serialize(row: Row, key: Any) -> KafkaMessage
247246
```
248247

249-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L198)
248+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L204)
250249

251250
Serialize Row to a Kafka message structure
252251

@@ -275,7 +274,7 @@ def row_deserialize(
275274
) -> Union[Row, List[Row], None]
276275
```
277276

278-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L238)
277+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/topic.py#L235)
279278

280279
Deserialize incoming Kafka message to a Row.
281280

@@ -440,10 +439,10 @@ a TopicConfig object
440439

441440
```python
442441
def topic(name: str,
443-
value_deserializer: Optional[DeserializerType] = None,
444-
key_deserializer: Optional[DeserializerType] = "bytes",
445-
value_serializer: Optional[SerializerType] = None,
446-
key_serializer: Optional[SerializerType] = "bytes",
442+
value_deserializer: DeserializerType = "json",
443+
key_deserializer: DeserializerType = "bytes",
444+
value_serializer: SerializerType = "json",
445+
key_serializer: SerializerType = "bytes",
447446
create_config: Optional[TopicConfig] = None,
448447
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
449448
```
@@ -502,14 +501,13 @@ The topic name and config can be updated by the topic manager.
502501
#### TopicManager.repartition\_topic
503502

504503
```python
505-
def repartition_topic(
506-
operation: str,
507-
stream_id: str,
508-
config: TopicConfig,
509-
value_deserializer: Optional[DeserializerType] = "json",
510-
key_deserializer: Optional[DeserializerType] = "json",
511-
value_serializer: Optional[SerializerType] = "json",
512-
key_serializer: Optional[SerializerType] = "json") -> Topic
504+
def repartition_topic(operation: str,
505+
stream_id: str,
506+
config: TopicConfig,
507+
value_deserializer: DeserializerType = "json",
508+
key_deserializer: DeserializerType = "json",
509+
value_serializer: SerializerType = "json",
510+
key_serializer: SerializerType = "json") -> Topic
513511
```
514512

515513
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L202)

0 commit comments

Comments
 (0)