Skip to content

Commit d202434

Browse files
swathipilswathipil
authored
[SchemaRegistry] avro sphinx docs/typing-extensions dependency (Azure#23756)
fixes: Azure#23288 fixes: Azure#22048
1 parent e53a1db commit d202434

File tree

14 files changed

+102
-21
lines changed

14 files changed

+102
-21
lines changed

‎.vscode/cspell.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,12 @@
410410
"unpartial",
411411
"alru"
412412
]
413+
},
414+
{
415+
"filename": "sdk/schemaregistry/azure-schemaregistry-avroencoder/doc/*.rst",
416+
"words": [
417+
"undoc"
418+
]
413419
}
414420
],
415421
"allowCompoundWords": true

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/MANIFEST.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ include azure/__init__.py
44
include azure/schemaregistry/__init__.py
55
recursive-include tests *.py
66
recursive-include samples *.py
7-
include azure/schemaregistry/encoder/avroencoder/py.typed
7+
include azure/schemaregistry/encoder/avroencoder/py.typed
8+
recursive-include doc *.rst

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pip install azure-schemaregistry-avroencoder azure-identity
2323
### Prerequisites:
2424
To use this package, you must have:
2525
* Azure subscription - [Create a free account][azure_sub]
26-
* [Azure Schema Registry][schemaregistry_service]
26+
* [Azure Schema Registry][schemaregistry_service] - [Here is the quickstart guide][quickstart_guide] to create a Schema Registry group using the Azure portal.
2727
* Python 3.6 or later - [Install Python][python]
2828

2929
### Authenticate the client
@@ -326,4 +326,5 @@ contact [[email protected]](mailto:[email protected]) with any additio
326326
[schemaregistry_service]: https://aka.ms/schemaregistry
327327
[eventhubs_repo]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventhub/azure-eventhub
328328
[token_credential_interface]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core/azure/core/credentials.py
329-
[pypi_azure_identity]: https://pypi.org/project/azure-identity/
329+
[pypi_azure_identity]: https://pypi.org/project/azure-identity/
330+
[quickstart_guide]: https://docs.microsoft.com/azure/event-hubs/create-schema-registry

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/azure/schemaregistry/encoder/avroencoder/_utils.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,14 @@ def validate_message(message: Union[MessageType, MessageContent]):
103103

104104
try:
105105
content_type_parts = content_type.split("+")
106-
if len(content_type_parts) != 2:
106+
if len(content_type_parts) != 2 or content_type_parts[0] != AVRO_MIME_TYPE:
107107
raise InvalidContentError(
108-
"Content type was not in the expected format of MIME type + schema ID."
108+
f"Content type {content_type} was not in the expected format of Avro MIME type + schema ID."
109109
)
110110
schema_id = content_type_parts[1]
111111
except AttributeError:
112112
raise InvalidContentError(
113-
f"Content type {content_type} was not in the expected format of MIME type + schema ID."
113+
f"Content type {content_type} was not in the expected format of Avro MIME type + schema ID."
114114
)
115115

116116
return schema_id, content

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/doc/azure.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
azure package
2+
=============
3+
4+
.. automodule:: azure
5+
:members:
6+
:undoc-members:
7+
:inherited-members:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
azure.schemaregistry

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/doc/azure.schemaregistry.encoder.avroencoder.aio.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
azure.schemaregistry.encoder.avroencoder.aio package
2+
====================================================
3+
4+
.. automodule:: azure.schemaregistry.encoder.avroencoder.aio
5+
:members:
6+
:undoc-members:
7+
:inherited-members:

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/doc/azure.schemaregistry.encoder.avroencoder.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
azure.schemaregistry.encoder.avroencoder package
2+
================================================
3+
4+
.. automodule:: azure.schemaregistry.encoder.avroencoder
5+
:members:
6+
:undoc-members:
7+
:inherited-members:
8+
:special-members: __message_content__
9+
10+
Subpackages
11+
-----------
12+
13+
.. toctree::
14+
:maxdepth: 4
15+
16+
azure.schemaregistry.encoder.avroencoder.aio

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/doc/azure.schemaregistry.encoder.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
azure.schemaregistry.encoder package
2+
====================================
3+
4+
.. automodule:: azure.schemaregistry.encoder
5+
:members:
6+
:undoc-members:
7+
:inherited-members:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
azure.schemaregistry.encoder.avroencoder

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/doc/azure.schemaregistry.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
azure.schemaregistry package
2+
============================
3+
4+
.. automodule:: azure.schemaregistry
5+
:members:
6+
:undoc-members:
7+
:inherited-members:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
azure.schemaregistry.encoder

‎sdk/schemaregistry/azure-schemaregistry-avroencoder/setup.py

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import sys
1111
import os.path
1212
from io import open
13-
from setuptools import find_packages, setup
13+
from setuptools import find_namespace_packages, setup
1414

1515
# Change the PACKAGE_NAME only to change folder and different name
1616
PACKAGE_NAME = "azure-schemaregistry-avroencoder"
@@ -32,16 +32,10 @@
3232
with open('CHANGELOG.md', encoding='utf-8') as f:
3333
changelog = f.read()
3434

35-
exclude_packages = [
36-
'tests',
37-
'samples',
38-
# Exclude packages that will be covered by PEP420 or nspkg
39-
'azure',
40-
'azure.schemaregistry',
41-
]
4235
install_packages = [
4336
'azure-schemaregistry>=1.0.0,<2.0.0',
44-
'avro>=1.11.0'
37+
'avro>=1.11.0',
38+
"typing-extensions>=4.0.1",
4539
]
4640

4741
setup(
@@ -67,9 +61,8 @@
6761
],
6862
python_requires=">=3.6",
6963
zip_safe=False,
70-
packages=[
71-
'azure.schemaregistry.encoder.avroencoder',
72-
'azure.schemaregistry.encoder.avroencoder.aio',
73-
],
64+
packages=find_namespace_packages(
65+
include=['azure.schemaregistry.encoder.*'] # Exclude packages that will be covered by PEP420 or nspkg
66+
),
7467
install_requires=install_packages
7568
)

0 commit comments

Comments
 (0)