Skip to content

Commit 6b33654

Browse files
authored
[SchemaRegistry] rename namespace (Azure#20965)
fixes: Azure#20711
1 parent cfb945d commit 6b33654

File tree

10 files changed

+31
-29
lines changed

10 files changed

+31
-29
lines changed

sdk/schemaregistry/azure-schemaregistry-avroserializer/CHANGELOG.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@
44

55
### Features Added
66

7-
- `auto_register_schemas` keyword argument has been added to `SchemaRegistryAvroSerializer`, which will allow for automatically registering schemas passed in to the `serialize`.
8-
- `value` parameter in `serialize` on `SchemaRegistryAvroSerializer` takes type `Mapping` rather than `Dict`.
7+
- `auto_register_schemas` keyword argument has been added to `AvroSerializer`, which will allow for automatically registering schemas passed in to the `serialize`.
8+
- `value` parameter in `serialize` on `AvroSerializer` takes type `Mapping` rather than `Dict`.
99

1010
### Breaking Changes
1111

12-
- `schema_registry` parameter in the `SchemaRegistryAvroSerializer` constructor has been renamed `client`.
13-
- `schema_group` parameter in the `SchemaRegistryAvroSerializer` constructor has been renamed `group_name`.
14-
- `data` parameter in the `serialize` and `deserialize` methods on `SchemaRegistryAvroSerializer` has been renamed `value`.
15-
- `schema` parameter in the `serialize` method on `SchemaRegistryAvroSerializer` no longer accepts argument of type `bytes`.
16-
- `SchemaRegistryAvroSerializer` constructor no longer takes in the `codec` keyword argument.
12+
- `SchemaRegistryAvroSerializer` has been renamed `AvroSerializer`.
13+
- `schema_registry` parameter in the `AvroSerializer` constructor has been renamed `client`.
14+
- `schema_group` parameter in the `AvroSerializer` constructor has been renamed `group_name`.
15+
- `data` parameter in the `serialize` and `deserialize` methods on `AvroSerializer` has been renamed `value`.
16+
- `schema` parameter in the `serialize` method on `AvroSerializer` no longer accepts argument of type `bytes`.
17+
- `AvroSerializer` constructor no longer takes in the `codec` keyword argument.
1718
- The following positional arguments are now required keyword arguments:
18-
- `client` and `group_name` in `SchemaRegistryAvroSerializer` constructor
19-
- `schema` in `serialize` on `SchemaRegistryAvroSerializer`
19+
- `client` and `group_name` in `AvroSerializer` constructor
20+
- `schema` in `serialize` on `AvroSerializer`
2021

2122
### Bugs Fixed
2223

sdk/schemaregistry/azure-schemaregistry-avroserializer/azure/schemaregistry/serializer/avroserializer/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727

2828
__version__ = VERSION
2929

30-
from ._schema_registry_avro_serializer import SchemaRegistryAvroSerializer
30+
from ._schema_registry_avro_serializer import AvroSerializer
3131

3232
__all__ = [
33-
"SchemaRegistryAvroSerializer"
33+
"AvroSerializer"
3434
]

sdk/schemaregistry/azure-schemaregistry-avroserializer/azure/schemaregistry/serializer/avroserializer/_schema_registry_avro_serializer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@
3535
from ._avro_serializer import AvroObjectSerializer
3636

3737

38-
class SchemaRegistryAvroSerializer(object):
38+
class AvroSerializer(object):
3939
"""
40-
SchemaRegistryAvroSerializer provides the ability to serialize and deserialize data according
40+
AvroSerializer provides the ability to serialize and deserialize data according
4141
to the given avro schema. It would automatically register, get and cache the schema.
4242
4343
:keyword client: Required. The schema registry client

sdk/schemaregistry/azure-schemaregistry-avroserializer/samples/avro_serializer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
from azure.identity import ClientSecretCredential
2929
from azure.schemaregistry import SchemaRegistryClient
30-
from azure.schemaregistry.serializer.avroserializer import SchemaRegistryAvroSerializer
30+
from azure.schemaregistry.serializer.avroserializer import AvroSerializer
3131

3232
TENANT_ID=os.environ['AZURE_TENANT_ID']
3333
CLIENT_ID=os.environ['AZURE_CLIENT_ID']
@@ -80,7 +80,7 @@ def deserialize(serializer, bytes_payload):
8080

8181
if __name__ == '__main__':
8282
schema_registry = SchemaRegistryClient(endpoint=SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE, credential=token_credential)
83-
serializer = SchemaRegistryAvroSerializer(client=schema_registry, group_name=GROUP_NAME, auto_register_schemas=True)
83+
serializer = AvroSerializer(client=schema_registry, group_name=GROUP_NAME, auto_register_schemas=True)
8484
bytes_data_ben, bytes_data_alice = serialize(serializer)
8585
dict_data_ben = deserialize(serializer, bytes_data_ben)
8686
dict_data_alice = deserialize(serializer, bytes_data_alice)

sdk/schemaregistry/azure-schemaregistry-avroserializer/samples/eventhub_receive_integration.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
# --------------------------------------------------------------------------------------------
77

88
"""
9-
Examples to show receiving events from EventHub with SchemaRegistryAvroSerializer integrated for data deserialization.
9+
Examples to show receiving events from EventHub with AvroSerializer integrated for data deserialization.
1010
"""
1111

1212
# pylint: disable=C0111
1313
import os
1414
from azure.eventhub import EventHubConsumerClient
1515
from azure.identity import DefaultAzureCredential
1616
from azure.schemaregistry import SchemaRegistryClient
17-
from azure.schemaregistry.serializer.avroserializer import SchemaRegistryAvroSerializer
17+
from azure.schemaregistry.serializer.avroserializer import AvroSerializer
1818

1919
EVENTHUB_CONNECTION_STR = os.environ['EVENT_HUB_CONN_STR']
2020
EVENTHUB_NAME = os.environ['EVENT_HUB_NAME']
@@ -44,9 +44,9 @@ def on_event(partition_context, event):
4444
)
4545

4646

47-
# create a SchemaRegistryAvroSerializer instance
47+
# create a AvroSerializer instance
4848
# TODO: after 'azure-schemaregistry==1.0.0b3' is released, update 'endpoint' to 'fully_qualified_namespace'
49-
avro_serializer = SchemaRegistryAvroSerializer(
49+
avro_serializer = AvroSerializer(
5050
client=SchemaRegistryClient(
5151
endpoint=SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE,
5252
credential=DefaultAzureCredential()

sdk/schemaregistry/azure-schemaregistry-avroserializer/samples/eventhub_send_integration.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# --------------------------------------------------------------------------------------------
77

88
"""
9-
Examples to show sending event to EventHub with SchemaRegistryAvroSerializer integrated for data serialization.
9+
Examples to show sending event to EventHub with AvroSerializer integrated for data serialization.
1010
"""
1111

1212
# pylint: disable=C0111
@@ -15,7 +15,7 @@
1515
from azure.eventhub import EventHubProducerClient, EventData
1616
from azure.identity import DefaultAzureCredential
1717
from azure.schemaregistry import SchemaRegistryClient
18-
from azure.schemaregistry.serializer.avroserializer import SchemaRegistryAvroSerializer
18+
from azure.schemaregistry.serializer.avroserializer import AvroSerializer
1919

2020
EVENTHUB_CONNECTION_STR = os.environ['EVENT_HUB_CONN_STR']
2121
EVENTHUB_NAME = os.environ['EVENT_HUB_NAME']
@@ -58,9 +58,9 @@ def send_event_data_batch(producer, serializer):
5858
)
5959

6060

61-
# create a SchemaRegistryAvroSerializer instance
61+
# create a AvroSerializer instance
6262
# TODO: after 'azure-schemaregistry==1.0.0b3' is released, update 'endpoint' to 'fully_qualified_namespace'
63-
avro_serializer = SchemaRegistryAvroSerializer(
63+
avro_serializer = AvroSerializer(
6464
client=SchemaRegistryClient(
6565
endpoint=SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE,
6666
credential=DefaultAzureCredential()

sdk/schemaregistry/azure-schemaregistry-avroserializer/tests/recordings/test_avro_serializer.test_basic_sr_avro_serializer_with_auto_register_schemas.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ interactions:
2828
content-type:
2929
- application/json
3030
date:
31-
- Tue, 28 Sep 2021 22:27:25 GMT
31+
- Thu, 30 Sep 2021 02:05:53 GMT
3232
location:
3333
- https://swathip-test-eventhubs.servicebus.windows.net:443/$schemagroups/fakegroup/schemas/example.avro.User/versions/1?api-version=2017-04
3434
server:

sdk/schemaregistry/azure-schemaregistry-avroserializer/tests/recordings/test_avro_serializer.test_basic_sr_avro_serializer_without_auto_register_schemas.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ interactions:
2828
content-type:
2929
- application/json
3030
date:
31-
- Tue, 28 Sep 2021 22:27:26 GMT
31+
- Thu, 30 Sep 2021 02:05:54 GMT
3232
location:
3333
- https://swathip-test-eventhubs.servicebus.windows.net:443/$schemagroups/fakegroup/schemas/example.avro.User/versions/1?api-version=2017-04
3434
server:

sdk/schemaregistry/azure-schemaregistry-avroserializer/tests/test_avro_serializer.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from io import BytesIO
2626

2727
from azure.schemaregistry import SchemaRegistryClient
28-
from azure.schemaregistry.serializer.avroserializer import SchemaRegistryAvroSerializer
28+
from azure.schemaregistry.serializer.avroserializer import AvroSerializer
2929
from azure.schemaregistry.serializer.avroserializer._avro_serializer import AvroObjectSerializer
3030
from azure.identity import ClientSecretCredential
3131
from azure.core.exceptions import ClientAuthenticationError, ServiceRequestError, HttpResponseError
@@ -34,7 +34,7 @@
3434

3535
SchemaRegistryPowerShellPreparer = functools.partial(PowerShellPreparer, "schemaregistry", schemaregistry_fully_qualified_namespace="fake_resource.servicebus.windows.net/", schemaregistry_group="fakegroup")
3636

37-
class SchemaRegistryAvroSerializerTests(AzureTestCase):
37+
class AvroSerializerTests(AzureTestCase):
3838

3939
def test_raw_avro_serializer(self):
4040
schema_str = """{"namespace":"example.avro","type":"record","name":"User","fields":[{"name":"name","type":"string"},{"name":"favorite_number","type":["int","null"]},{"name":"favorite_color","type":["string","null"]}]}"""
@@ -78,7 +78,7 @@ def test_raw_avro_serializer_negative(self):
7878
def test_basic_sr_avro_serializer_with_auto_register_schemas(self, schemaregistry_fully_qualified_namespace, schemaregistry_group, **kwargs):
7979
# TODO: AFTER RELEASING azure-schemaregistry=1.0.0b3, UPDATE 'endpoint' to 'fully_qualified_namespace'
8080
sr_client = self.create_basic_client(SchemaRegistryClient, endpoint=schemaregistry_fully_qualified_namespace)
81-
sr_avro_serializer = SchemaRegistryAvroSerializer(client=sr_client, group_name=schemaregistry_group, auto_register_schemas=True)
81+
sr_avro_serializer = AvroSerializer(client=sr_client, group_name=schemaregistry_group, auto_register_schemas=True)
8282

8383
schema_str = """{"namespace":"example.avro","type":"record","name":"User","fields":[{"name":"name","type":"string"},{"name":"favorite_number","type":["int","null"]},{"name":"favorite_color","type":["string","null"]}]}"""
8484
schema = avro.schema.parse(schema_str)
@@ -103,7 +103,7 @@ def test_basic_sr_avro_serializer_with_auto_register_schemas(self, schemaregistr
103103
def test_basic_sr_avro_serializer_without_auto_register_schemas(self, schemaregistry_fully_qualified_namespace, schemaregistry_group, **kwargs):
104104
# TODO: AFTER RELEASING azure-schemaregistry=1.0.0b3, UPDATE 'endpoint' to 'fully_qualified_namespace'
105105
sr_client = self.create_basic_client(SchemaRegistryClient, endpoint=schemaregistry_fully_qualified_namespace)
106-
sr_avro_serializer = SchemaRegistryAvroSerializer(client=sr_client, group_name=schemaregistry_group)
106+
sr_avro_serializer = AvroSerializer(client=sr_client, group_name=schemaregistry_group)
107107

108108
schema_str = """{"namespace":"example.avro","type":"record","name":"User","fields":[{"name":"name","type":"string"},{"name":"favorite_number","type":["int","null"]},{"name":"favorite_color","type":["string","null"]}]}"""
109109
schema = avro.schema.parse(schema_str)

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/serializer/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@
2323
# IN THE SOFTWARE.
2424
#
2525
# --------------------------------------------------------------------------
26+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore

0 commit comments

Comments
 (0)