os-core-lib-python-azure snapshot @af3b68f

.gitignore

+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# ide
+.idea/
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv*
+env/
+venv/
+venv*/
+ENV/
+env.bak/
+venv.bak/
+.virtualenv/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

LICENSE.TXT

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
\ No newline at end of file

README.md

+## Introduction 
+Python package for osdu Azure cloud implementations.
+
+## Requirements and dependencies
+Requires Python 3.7+ and depends on osdu-core-lib-python
+
+## Getting Started
+
+### from package
+install from package:
+
+`pip install osdu-core-lib-python-azure`
+
+### from sources
+install dependencies:
+
+`pip install -r requirements.txt`
+
+
+## Tests
+
+### install dependencies
+unit tests uses [pytest](https://docs.pytest.org/en/stable/) framework. Other dependencies are 
+[pytest-asyncio](https://pypi.org/project/pytest-asyncio/) for testing asyncio code and 
+[pytest-cov](https://pypi.org/project/pytest-cov/) to produce coverage report.
+
+
+### run unit tests
+
+install testing dependencies:
+
+`pip install -r requirements_dev.txt`
+
+run all tests:
+
+`python -m pytest ./tests`
+
+run all tests and produce reports:
+
+`python -m pytest --junit-xml=unit_tests_report.xml --cov=osdu_az --cov-report=html --cov-report=xml ./tests`
+
+## License
+Apache version 2.0 (see LICENSE.TXT)
+
+## Contribute
+Note: version number must be updated manually for now. Increment by one the version patch part in file osdu_az/\_\_init\_\_.py

osdu_az/__init__.py

+__version__ = '0.0.2'

osdu_az/storage/blob_storage_az.py

+from osdu.core.api.storage.blob_storage_base import BlobStorageBase
+from osdu.core.api.storage.blob import Blob
+from typing import Optional, List, Any
+
+
+class AzureAioBlobStorage(BlobStorageBase):
+
+    async def list_objects(self, project: str, container: str,
+                           *, auth: Optional = None, prefix: str = '', page_token: Optional[str] = None,
+                           max_result: Optional[int] = None, timeout: int = 10, **kwargs) -> List[str]:
+        """
+            list all object within a bucket
+            :param auth: auth obj to perform the operation
+            :param project: project or account
+            :param container: container or bucket name
+            :param prefix: Filter results to objects whose names begin with this prefix
+            :param page_token: A previously-returned page token representing part of the larger set of results to view.
+            :param max_result: Maximum number of items to return.
+            :param timeout: timeout
+            :param kwargs:
+            :return: list of blob names
+            """
+        raise NotImplementedError('Azure blob storage implementation, "list_objects" not implemented')
+
+    async def delete(self, project: str, container: str, object_name: str,
+                     *, auth: Optional = None, timeout: int = 10, **kwargs):
+        """
+            delete an object
+            :param auth: auth obj to perform the operation
+            :param project: project or account
+            :param container: container or bucket name
+            :param object_name:
+            :param timeout:
+            :param kwargs:
+            :return:
+            """
+        raise NotImplementedError('Azure blob storage implementation, "delete" not implemented')
+
+    async def download(self, project: str, container: str, object_name: str,
+                       *, auth: Optional = None, timeout: int = 10, **kwargs) -> bytes:
+        """
+            download blob data
+            :param auth: auth obj to perform the operation
+            :param project: project or account
+            :param container: container or bucket name
+            :param object_name:
+            :param timeout:
+            :param kwargs:
+            :return:
+            """
+        raise NotImplementedError('Azure blob storage implementation, "download" not implemented')
+
+    async def download_metadata(self, project: str, container: str, object_name: str,
+                                *, auth: Optional = None, timeout: int = 10, **kwargs) -> Blob:
+        """
+            download blob data
+            :param auth: auth obj to perform the operation
+            :param project: project or account
+            :param container: container or bucket name
+            :param object_name:
+            :param timeout:
+            :param kwargs:
+            :return: blob
+            """
+        raise NotImplementedError('Azure blob storage implementation, "download_metadata" not implemented')
+
+    async def upload(self, project: str, container: str, object_name: str, file_data: Any,
+                     *, auth: Optional = None, content_type: str = None, metadata: dict = None,
+                     timeout: int = 30, **kwargs):
+        raise NotImplementedError('Azure blob storage implementation, "upload" not implemented')

requirements.txt

+# osdu core lib main python
+osdu-core-lib-python>=0.3.0, <0.4

requirements_dev.txt

+pytest>=3
+pytest-asyncio
+pytest-cov

setup.py

+import os
+import re
+from setuptools import setup, find_packages
+
+requirements_file = os.path.abspath(
+    os.path.join(os.path.dirname(__file__), 'requirements.txt')
+)
+
+test_requirements_file = os.path.abspath(
+    os.path.join(os.path.dirname(__file__), 'requirements_dev.txt')
+)
+
+
+# version is unified in osdu_az/__init__.py
+def read_version():
+    regexp = re.compile(r"^__version__\W*=\W*'([\d.abrc]+(dev\d+)?)'")
+    init_py = os.path.join(os.path.dirname(__file__), 'osdu_az', '__init__.py')
+    with open(init_py) as f:
+        for line in f:
+            match = regexp.match(line)
+            if match is not None:
+                return match.group(1)
+        raise RuntimeError('Cannot find version in {}'.format(init_py))
+
+
+with open(requirements_file) as f:
+    requirements = f.read().splitlines()
+
+with open(test_requirements_file) as f:
+    test_requirements = f.read().splitlines()
+
+setup(
+    name='osdu-core-lib-python-azure',
+
+    version=read_version(),
+
+    packages=find_packages(),
+
+    author="OSDU Wellbore data domain services team",
+
+    author_email="WellboreDDMS@slb.com",
+
+    description="OSDU python for wellbore DMS - azure cloud implementations",
+
+    long_description=open('README.md').read(),
+
+    include_package_data=True,
+
+    install_requires=requirements,
+
+    tests_require=test_requirements,
+
+    license="Apache License, Version 2.0",
+
+    # We need py 3.7 for some of the tools used here
+    python_requires='>=3.7',
+)

tests/storage/test_blob_storage_az.py

+from osdu_az.storage.blob_storage_az import AzureAioBlobStorage
+import pytest
+
+
+@pytest.fixture
+async def az_client() -> AzureAioBlobStorage:
+    yield AzureAioBlobStorage()
+
+
+async def assert_not_implemented(coro):
+    with pytest.raises(NotImplementedError) as ex_info:
+        await coro
+    ex = ex_info.value
+    assert 'azure' in str(ex).lower()
+
+
+@pytest.mark.asyncio
+async def test_list_objects_should_throw_not_implemented(az_client: AzureAioBlobStorage):
+    await assert_not_implemented(
+        az_client.list_objects('project', 'container')
+    )
+
+
+@pytest.mark.asyncio
+async def test_delete_should_throw_not_implemented(az_client: AzureAioBlobStorage):
+    await assert_not_implemented(
+        az_client.delete('project', 'container', 'id')
+    )
+
+
+@pytest.mark.asyncio
+async def test_download_metadata_should_throw_not_implemented(az_client: AzureAioBlobStorage):
+    await assert_not_implemented(
+        az_client.download_metadata('project', 'container', 'id')
+    )
+
+
+@pytest.mark.asyncio
+async def test_download_should_throw_not_implemented(az_client: AzureAioBlobStorage):
+    await assert_not_implemented(
+        az_client.download('project', 'container', 'id')
+    )
+
+
+@pytest.mark.asyncio
+async def test_upload_should_throw_not_implemented(az_client: AzureAioBlobStorage):
+    await assert_not_implemented(
+        az_client.upload('project', 'container', 'id', '')
+    )
+
+
+