evo-files 0.1.0__tar.gz → 0.2.0__tar.gz

evo_files-0.2.0/.gitignore

@@ -0,0 +1,24 @@
+# IDE Settings
+.idea/
+.project
+.pydevproject
+.vscode/
+
+# Distribution / Packaging
+*.egg*
+*.whl
+__pycache__/
+site/
+build/
+
+# Reporting
+.coverage
+
+# Environmnents
+venv/
+venv*/
+.venv/
+.env
+.tox/
+
+.DS_store

{evo_files-0.1.0 → evo_files-0.2.0}/PKG-INFO

@@ -1,26 +1,30 @@
 Metadata-Version: 2.4
 Name: evo-files
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python SDK for using the Seequent Evo File API
+Project-URL: Source, https://github.com/SeequentEvo/evo-python-sdk
+Project-URL: Tracker, https://github.com/SeequentEvo/evo-python-sdk/issues
+Project-URL: Homepage, https://www.seequent.com/
+Project-URL: Documentation, https://developer.seequent.com/
 Author-email: Seequent <support@seequent.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Python: >=3.10
 Requires-Dist: evo-sdk-common>=0.1.0
 Requires-Dist: pydantic<3,>=2
 Provides-Extra: aiohttp
-Requires-Dist: evo-sdk-common[aiohttp]>=0.1.0; extra == "aiohttp"
+Requires-Dist: evo-sdk-common[aiohttp]>=0.1.0; extra == 'aiohttp'
 Provides-Extra: notebooks
-Requires-Dist: evo-sdk-common[notebooks]>=0.1.0; extra == "notebooks"
-Dynamic: license-file
+Requires-Dist: evo-sdk-common[notebooks]>=0.1.0; extra == 'notebooks'
+Description-Content-Type: text/markdown
 
 <p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
 <p align="center">
+    <a href="https://pypi.org/project/evo-files/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-files" /></a>
     <a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml/badge.svg" alt="" /></a>
 </p>
 <p align="center">
     <a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
-    &bull; <a href="https://community.seequent.com/" target="_blank">Seequent Community</a>
+    &bull; <a href="https://community.seequent.com/group/19-evo" target="_blank">Seequent Community</a>
     &bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
 </p>
 
@@ -36,12 +40,28 @@ formats and sizes are accepted.
 pip install evo-files 
 ```
 
+## Usage
+
+To get up and running quickly with the Evo File SDK, start by configuring your
+[environment and API connector](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-sdk-common/docs/quickstart.md).
+
+You can then use the `FileAPIClient` to perform operations, for example:
+
+```python
+from evo.files import FileAPIClient
+
+file_client = FileAPIClient(environment, connector)
+files = await file_client.list_files()
+```
+
+For some interactive Jupyter notebook examples, see the [examples folder](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/evo-files/docs/examples).
+
 ## Developing the library
 
 For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
 
 ## License
-The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](./LICENSE.md).
+The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/evo-files/./LICENSE.md).
 
 Copyright © 2025 Bentley Systems, Incorporated.
 

evo_files-0.2.0/pyproject.toml

@@ -0,0 +1,73 @@
+[project]
+name = "evo-files"
+description = "Python SDK for using the Seequent Evo File API"
+version = "0.2.0"
+requires-python = ">=3.10"
+license-files = ["LICENSE.md"]
+dynamic = ["readme"]
+authors = [
+    { name = "Seequent", email = "support@seequent.com" }
+]
+
+dependencies = [
+    "evo-sdk-common>=0.1.0",
+    "pydantic>=2,<3",
+]
+
+[project.urls]
+Source = "https://github.com/SeequentEvo/evo-python-sdk"
+Tracker = "https://github.com/SeequentEvo/evo-python-sdk/issues"
+Homepage = "https://www.seequent.com/"
+Documentation = "https://developer.seequent.com/"
+
+[project.optional-dependencies]
+aiohttp = ["evo-sdk-common[aiohttp]>=0.1.0"]
+notebooks = ["evo-sdk-common[notebooks]>=0.1.0"]
+
+[dependency-groups]
+# Dev dependencies. The version is left unspecified so the latest is installed.
+test = [
+    "evo-files[aiohttp]",
+    "parameterized==0.9.0",
+    "pytest",
+]
+dev = [
+    "evo-files[aiohttp]",
+    "bumpver",
+    "coverage[toml]",
+    "ruff",
+    {include-group="test"},
+]
+notebooks = [
+    "evo-files[aiohttp,notebooks]",
+    "jupyter",
+]
+
+[tool.ruff]
+src = ["src", "tests"]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = ["I", "RUF022"]
+
+[build-system]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = ["src"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/evo"]
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+# Literal TOML strings (single quotes) need no escaping of backslashes.
+# Converts relative links to absolute links in PyPI
+pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
+replacement = '[\1](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/$HFPR_PACKAGE_NAME/\g<2>)'

{evo_files-0.1.0 → evo_files-0.2.0}/src/evo/files/io.py

@@ -144,7 +144,7 @@ class FileAPIDownload(Download[FileMetadata], _FileIOMixin):
     def __init__(self, connector: APIConnector, metadata: FileMetadata, initial_url: str) -> None:
         """
         :param connector: The connector to use for the API calls.
-        :param metadata: The metadata of the file that wil be downloaded.
+        :param metadata: The metadata of the file that will be downloaded.
         :param initial_url: The initial URL to use for the download.
         """
         super().__init__(connector, initial_url)

evo_files-0.1.0/README.md

@@ -1,42 +0,0 @@
-<p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
-<p align="center">
-    <a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml/badge.svg" alt="" /></a>
-</p>
-<p align="center">
-    <a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
-    &bull; <a href="https://community.seequent.com/" target="_blank">Seequent Community</a>
-    &bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
-</p>
-
-# Evo File API Client
-
-The File API provides the ability to manage files of any type or size, associated with your Evo workspace.
-Enable your product with Evo connected workflows by integrating with the Seequent Evo File API. Most file
-formats and sizes are accepted.
-
-## Installation
-
-```
-pip install evo-files 
-```
-
-## Developing the library
-
-For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
-
-## License
-The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](./LICENSE.md).
-
-Copyright © 2025 Bentley Systems, Incorporated.
-
-Licensed under the Apache License, Version 2.0 (the "License").
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-

evo_files-0.1.0/pyproject.toml

@@ -1,65 +0,0 @@
-[build-system]
-requires = ["setuptools >= 61.0.0"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "evo-files"
-description = "Python SDK for using the Seequent Evo File API"
-version = "0.1.0"
-requires-python = ">=3.10"
-license-files = ["LICENSE.md"]
-readme = "README.md"
-authors = [
-    { name = "Seequent", email = "support@seequent.com" }
-]
-dependencies = [
-    "evo-sdk-common>=0.1.0",
-    "pydantic>=2,<3",
-]
-
-[project.optional-dependencies]
-aiohttp = ["evo-sdk-common[aiohttp]>=0.1.0"]
-notebooks = ["evo-sdk-common[notebooks]>=0.1.0"]
-
-[dependency-groups]
-# Dev dependencies. The version is left unspecified so the latest is installed.
-test = [
-    "evo-files[aiohttp]",
-    "parameterized==0.9.0",
-    "pytest",
-]
-dev = [
-    "evo-files[aiohttp]",
-    "bumpver",
-    "coverage[toml]",
-    "ruff",
-    {include-group="test"},
-]
-notebooks = [
-    "evo-files[aiohttp,notebooks]",
-    "jupyter",
-]
-
-[tool.setuptools.packages.find]
-where = ["src"]
-namespaces = true
-
-[tool.ruff]
-src = ["src", "tests"]
-line-length = 120
-
-[tool.ruff.lint]
-extend-select = ["I", "RUF022"]
-
-[tool.bumpver]
-current_version = "v0.1.0"
-version_pattern = "vMAJOR.MINOR.PATCH[.PYTAGNUM]"
-commit = true
-tag = true
-commit_message = "Bump version from {old_version} to {new_version}"
-
-[tool.bumpver.file_patterns]
-"pyproject.toml" = [
-    'version = "{pep440_version}"',
-    'current_version = "{version}"',
-]

evo_files-0.1.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

evo_files-0.1.0/src/evo_files.egg-info/PKG-INFO

@@ -1,58 +0,0 @@
-Metadata-Version: 2.4
-Name: evo-files
-Version: 0.1.0
-Summary: Python SDK for using the Seequent Evo File API
-Author-email: Seequent <support@seequent.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
-Requires-Dist: evo-sdk-common>=0.1.0
-Requires-Dist: pydantic<3,>=2
-Provides-Extra: aiohttp
-Requires-Dist: evo-sdk-common[aiohttp]>=0.1.0; extra == "aiohttp"
-Provides-Extra: notebooks
-Requires-Dist: evo-sdk-common[notebooks]>=0.1.0; extra == "notebooks"
-Dynamic: license-file
-
-<p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
-<p align="center">
-    <a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml/badge.svg" alt="" /></a>
-</p>
-<p align="center">
-    <a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
-    &bull; <a href="https://community.seequent.com/" target="_blank">Seequent Community</a>
-    &bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
-</p>
-
-# Evo File API Client
-
-The File API provides the ability to manage files of any type or size, associated with your Evo workspace.
-Enable your product with Evo connected workflows by integrating with the Seequent Evo File API. Most file
-formats and sizes are accepted.
-
-## Installation
-
-```
-pip install evo-files 
-```
-
-## Developing the library
-
-For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
-
-## License
-The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](./LICENSE.md).
-
-Copyright © 2025 Bentley Systems, Incorporated.
-
-Licensed under the Apache License, Version 2.0 (the "License").
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-

evo_files-0.1.0/src/evo_files.egg-info/SOURCES.txt

@@ -1,20 +0,0 @@
-LICENSE.md
-README.md
-pyproject.toml
-src/evo/files/__init__.py
-src/evo/files/_model_config.py
-src/evo/files/client.py
-src/evo/files/data.py
-src/evo/files/io.py
-src/evo/files/endpoints/__init__.py
-src/evo/files/endpoints/models.py
-src/evo/files/endpoints/api/__init__.py
-src/evo/files/endpoints/api/file_v2_api.py
-src/evo_files.egg-info/PKG-INFO
-src/evo_files.egg-info/SOURCES.txt
-src/evo_files.egg-info/dependency_links.txt
-src/evo_files.egg-info/requires.txt
-src/evo_files.egg-info/top_level.txt
-tests/test_file_api_client.py
-tests/test_file_io.py
-tests/test_make_name_safe.py

evo_files-0.1.0/src/evo_files.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

evo_files-0.1.0/src/evo_files.egg-info/requires.txt

@@ -1,8 +0,0 @@
-evo-sdk-common>=0.1.0
-pydantic<3,>=2
-
-[aiohttp]
-evo-sdk-common[aiohttp]>=0.1.0
-
-[notebooks]
-evo-sdk-common[notebooks]>=0.1.0

evo_files-0.1.0/src/evo_files.egg-info/top_level.txt

@@ -1 +0,0 @@
-evo

evo_files-0.1.0/tests/test_file_api_client.py

@@ -1,534 +0,0 @@
-#  Copyright © 2025 Bentley Systems, Incorporated
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-
-import json
-from unittest import mock
-from uuid import UUID
-
-from data import load_test_data
-from evo.common import Environment, HealthCheckType, Page, RequestMethod, ServiceUser
-from evo.common.test_tools import BASE_URL, ORG, WORKSPACE_ID, MockResponse, TestWithConnector, utc_datetime
-from evo.files import FileAPIClient, FileAPIDownload, FileAPIUpload, FileMetadata, FileVersion
-
-
-class TestFileApiClient(TestWithConnector):
-    def setUp(self) -> None:
-        TestWithConnector.setUp(self)
-        self.environment = Environment(hub_url=BASE_URL, org_id=ORG.id, workspace_id=WORKSPACE_ID)
-        self.file_api_client = FileAPIClient(connector=self.connector, environment=self.environment)
-
-    @property
-    def base_path(self) -> str:
-        return f"file/v2/orgs/{self.environment.org_id}/workspaces/{self.environment.workspace_id}"
-
-    async def test_check_service_health(self) -> None:
-        """Test service health check implementation"""
-        with mock.patch("evo.files.client.get_service_health", spec_set=True) as mock_get_service_health:
-            await self.file_api_client.get_service_health()
-        mock_get_service_health.assert_called_once_with(self.connector, "file", check_type=HealthCheckType.FULL)
-
-    async def test_list_files_default_args(self) -> None:
-        empty_content = load_test_data("list_files_empty.json")
-        with self.transport.set_http_response(
-            200, json.dumps(empty_content), headers={"Content-Type": "application/json"}
-        ):
-            page = await self.file_api_client.list_files()
-        self.assertIsInstance(page, Page)
-        self.assertEqual([], page.items())
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files?limit=5000&offset=0",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_list_files_all_args(self) -> None:
-        empty_content = load_test_data("list_files_empty.json")
-        with self.transport.set_http_response(
-            200, json.dumps(empty_content), headers={"Content-Type": "application/json"}
-        ):
-            page = await self.file_api_client.list_files(limit=20, offset=10, name="x.csv")
-        self.assertIsInstance(page, Page)
-        self.assertEqual([], page.items())
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files?limit=20&offset=10&file_name=x.csv",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_list_files(self) -> None:
-        content_0 = load_test_data("list_files_0.json")
-        content_1 = load_test_data("list_files_1.json")
-        responses = [
-            MockResponse(status_code=200, content=json.dumps(content_0), headers={"Content-Type": "application/json"}),
-            MockResponse(status_code=200, content=json.dumps(content_1), headers={"Content-Type": "application/json"}),
-        ]
-        self.transport.request.side_effect = responses
-        page_one = await self.file_api_client.list_files(limit=2)
-        expected_files_page_one = [
-            FileMetadata(
-                environment=self.environment,
-                id=UUID(int=2),
-                name="x.csv",
-                created_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                created_at=utc_datetime(2020, 1, 1, 1, 30),
-                modified_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                modified_at=utc_datetime(2020, 1, 1, 1, 30),
-                parent="/A/",
-                size=11,
-                version_id="2",
-            ),
-            FileMetadata(
-                environment=self.environment,
-                id=UUID(int=3),
-                name="y.csv",
-                created_by=ServiceUser(
-                    id=UUID(int=17),
-                    name=None,
-                    email=None,
-                ),
-                created_at=utc_datetime(2020, 1, 2, 1, 30),
-                modified_by=ServiceUser(
-                    id=UUID(int=17),
-                    name=None,
-                    email=None,
-                ),
-                modified_at=utc_datetime(2020, 1, 2, 1, 30),
-                parent="/A/",
-                size=12,
-                version_id="1",
-            ),
-        ]
-        self.assertIsInstance(page_one, Page)
-        self.assertEqual(expected_files_page_one, page_one.items())
-        self.assertEqual(0, page_one.offset)
-        self.assertEqual(2, page_one.limit)
-        self.assertFalse(page_one.is_last)
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files?limit=2&offset=0",
-            headers={"Accept": "application/json"},
-        )
-        self.transport.request.reset_mock()
-
-        page_two = await self.file_api_client.list_files(offset=page_one.next_offset, limit=page_one.limit)
-        expected_files_page_two = [
-            FileMetadata(
-                environment=self.environment,
-                id=UUID(int=4),
-                name="z.csv",
-                created_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                created_at=utc_datetime(2020, 1, 1, 1, 30),
-                modified_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                modified_at=utc_datetime(2020, 1, 1, 1, 30),
-                parent="/B/",
-                size=13,
-                version_id="3",
-            ),
-        ]
-        self.assertIsInstance(page_two, Page)
-        self.assertEqual(expected_files_page_two, page_two.items())
-        self.assertEqual(2, page_two.offset)
-        self.assertEqual(2, page_two.limit)
-        self.assertTrue(page_two.is_last)
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files?limit=2&offset=2",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_list_all_files(self) -> None:
-        content_0 = load_test_data("list_files_0.json")
-        content_1 = load_test_data("list_files_1.json")
-        responses = [
-            MockResponse(status_code=200, content=json.dumps(content_0), headers={"Content-Type": "application/json"}),
-            MockResponse(status_code=200, content=json.dumps(content_1), headers={"Content-Type": "application/json"}),
-        ]
-        self.transport.request.side_effect = responses
-        file_list = await self.file_api_client.list_all_files(limit_per_request=2)
-        expected_files = [
-            FileMetadata(
-                environment=self.environment,
-                id=UUID(int=2),
-                name="x.csv",
-                created_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                created_at=utc_datetime(2020, 1, 1, 1, 30),
-                modified_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                modified_at=utc_datetime(2020, 1, 1, 1, 30),
-                parent="/A/",
-                size=11,
-                version_id="2",
-            ),
-            FileMetadata(
-                environment=self.environment,
-                id=UUID(int=3),
-                name="y.csv",
-                created_by=ServiceUser(
-                    id=UUID(int=17),
-                    name=None,
-                    email=None,
-                ),
-                created_at=utc_datetime(2020, 1, 2, 1, 30),
-                modified_by=ServiceUser(
-                    id=UUID(int=17),
-                    name=None,
-                    email=None,
-                ),
-                modified_at=utc_datetime(2020, 1, 2, 1, 30),
-                parent="/A/",
-                size=12,
-                version_id="1",
-            ),
-            FileMetadata(
-                environment=self.environment,
-                id=UUID(int=4),
-                name="z.csv",
-                created_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                created_at=utc_datetime(2020, 1, 1, 1, 30),
-                modified_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-                modified_at=utc_datetime(2020, 1, 1, 1, 30),
-                parent="/B/",
-                size=13,
-                version_id="3",
-            ),
-        ]
-
-        self.assertEqual(expected_files, file_list)
-        self.assert_any_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files?limit=2&offset=0",
-            headers={"Accept": "application/json"},
-        )
-        self.assert_any_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files?limit=2&offset=2",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_get_file_by_path(self) -> None:
-        get_file_response = load_test_data("get_file.json")
-        path = "points.csv"
-        expected_metadata = FileMetadata(
-            environment=self.environment,
-            id=UUID(int=6),
-            name="points.csv",
-            created_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            created_at=utc_datetime(2020, 1, 1, 1, 30),
-            modified_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            modified_at=utc_datetime(2020, 1, 1, 1, 30),
-            parent="/",
-            size=10,
-            version_id="1",
-        )
-
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(get_file_response), headers={"Content-Type": "application/json"}
-        ):
-            actual_metadata = await self.file_api_client.get_file_by_path(path)
-
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files/path/{path}",
-            headers={"Accept": "application/json"},
-        )
-        self.assertEqual(expected_metadata, actual_metadata)
-
-    async def test_prepare_download_by_path(self) -> None:
-        get_file_response = load_test_data("get_file.json")
-        path = "points.csv"
-        expected_metadata = FileMetadata(
-            environment=self.environment,
-            id=UUID(int=6),
-            name="points.csv",
-            created_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            created_at=utc_datetime(2020, 1, 1, 1, 30),
-            modified_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            modified_at=utc_datetime(2020, 1, 1, 1, 30),
-            parent="/",
-            size=10,
-            version_id="1",
-        )
-
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(get_file_response), headers={"Content-Type": "application/json"}
-        ):
-            download = await self.file_api_client.prepare_download_by_path(path)
-
-        self.assertIsInstance(download, FileAPIDownload)
-        self.assertEqual(expected_metadata, download.metadata)
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files/path/{path}",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_get_file_by_id(self) -> None:
-        get_file_response = load_test_data("get_file.json")
-        file_id = UUID(int=6)
-        expected_metadata = FileMetadata(
-            environment=self.environment,
-            id=file_id,
-            name="points.csv",
-            created_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            created_at=utc_datetime(2020, 1, 1, 1, 30),
-            modified_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            modified_at=utc_datetime(2020, 1, 1, 1, 30),
-            parent="/",
-            size=10,
-            version_id="1",
-        )
-
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(get_file_response), headers={"Content-Type": "application/json"}
-        ):
-            actual_metadata = await self.file_api_client.get_file_by_id(file_id)
-
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files/{file_id}",
-            headers={"Accept": "application/json"},
-        )
-        self.assertEqual(expected_metadata, actual_metadata)
-
-    async def test_prepare_download_by_id(self) -> None:
-        get_file_response = load_test_data("get_file.json")
-        file_id = UUID(int=6)
-        expected_metadata = FileMetadata(
-            environment=self.environment,
-            id=file_id,
-            name="points.csv",
-            created_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            created_at=utc_datetime(2020, 1, 1, 1, 30),
-            modified_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            modified_at=utc_datetime(2020, 1, 1, 1, 30),
-            parent="/",
-            size=10,
-            version_id="1",
-        )
-
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(get_file_response), headers={"Content-Type": "application/json"}
-        ):
-            download = await self.file_api_client.prepare_download_by_id(file_id)
-
-        self.assertIsInstance(download, FileAPIDownload)
-        self.assertEqual(expected_metadata, download.metadata)
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files/{file_id}",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_list_versions_by_path(self) -> None:
-        file_path = "points.csv"
-        list_versions_response = load_test_data("list_versions.json")
-        with self.transport.set_http_response(
-            200, json.dumps(list_versions_response), headers={"Content-Type": "application/json"}
-        ):
-            versions = await self.file_api_client.list_versions_by_path(file_path)
-        expected_versions = [
-            FileVersion(
-                version_id="3",
-                created_at=utc_datetime(2020, 1, 3, 1, 30),
-                created_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-            ),
-            FileVersion(
-                version_id="2",
-                created_at=utc_datetime(2020, 1, 2, 1, 30),
-                created_by=ServiceUser(
-                    id=UUID(int=17),
-                    name="x z",
-                    email="test@example.com",
-                ),
-            ),
-            FileVersion(
-                version_id="1",
-                created_at=utc_datetime(2020, 1, 1, 1, 30),
-                created_by=ServiceUser(
-                    id=UUID("00000000-0000-0000-0000-000000000012"),
-                    name="x w",
-                    email="test@example.com",
-                ),
-            ),
-        ]
-
-        self.assertEqual(versions, expected_versions)
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files/path/points.csv?include_versions=True",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_list_versions_by_id(self) -> None:
-        file_id = UUID(int=6)
-        list_versions_response = load_test_data("list_versions.json")
-        with self.transport.set_http_response(
-            200, json.dumps(list_versions_response), headers={"Content-Type": "application/json"}
-        ):
-            versions = await self.file_api_client.list_versions_by_id(file_id)
-        expected_versions = [
-            FileVersion(
-                version_id="3",
-                created_at=utc_datetime(2020, 1, 3, 1, 30),
-                created_by=ServiceUser(
-                    id=UUID(int=16),
-                    name="x y",
-                    email="test@example.com",
-                ),
-            ),
-            FileVersion(
-                version_id="2",
-                created_at=utc_datetime(2020, 1, 2, 1, 30),
-                created_by=ServiceUser(
-                    id=UUID(int=17),
-                    name="x z",
-                    email="test@example.com",
-                ),
-            ),
-            FileVersion(
-                version_id="1",
-                created_at=utc_datetime(2020, 1, 1, 1, 30),
-                created_by=ServiceUser(
-                    id=UUID("00000000-0000-0000-0000-000000000012"),
-                    name="x w",
-                    email="test@example.com",
-                ),
-            ),
-        ]
-
-        self.assertEqual(versions, expected_versions)
-        self.assert_request_made(
-            method=RequestMethod.GET,
-            path=f"{self.base_path}/files/{file_id}?include_versions=True",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_prepare_upload_by_path(self) -> None:
-        upsert_file_response = load_test_data("upsert_file.json")
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(upsert_file_response), headers={"Content-Type": "application/json"}
-        ):
-            upload = await self.file_api_client.prepare_upload_by_path("points.csv")
-
-        self.assertIsInstance(upload, FileAPIUpload)
-        self.assertEqual(upsert_file_response["file_id"], str(upload._id))
-        self.assertEqual(upsert_file_response["version_id"], upload._version_id)
-        self.assert_request_made(
-            method=RequestMethod.PUT,
-            path=f"{self.base_path}/files/path/points.csv",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_update_file_by_id(self) -> None:
-        update_file_response = load_test_data("update_file.json")
-        file_id = UUID(int=5)
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(update_file_response), headers={"Content-Type": "application/json"}
-        ):
-            upload = await self.file_api_client.prepare_upload_by_id(file_id)
-
-        self.assertIsInstance(upload, FileAPIUpload)
-        self.assertEqual(update_file_response["file_id"], str(upload._id))
-        self.assertEqual(update_file_response["version_id"], upload._version_id)
-        self.assert_request_made(
-            method=RequestMethod.PUT,
-            path=f"{self.base_path}/files/{file_id}",
-            headers={"Accept": "application/json"},
-        )
-
-    async def test_delete_file_by_path(self) -> None:
-        path = "points.csv"
-        with self.transport.set_http_response(
-            status_code=204, content="", headers={"Content-Type": "application/json"}
-        ):
-            await self.file_api_client.delete_file_by_path(path)
-        self.assert_request_made(
-            method=RequestMethod.DELETE,
-            path=f"{self.base_path}/files/path/{path}",
-        )
-
-    async def test_delete_file_by_id(self) -> None:
-        file_id = UUID(int=6)
-        with self.transport.set_http_response(
-            status_code=204, content="", headers={"Content-Type": "application/json"}
-        ):
-            await self.file_api_client.delete_file_by_id(file_id)
-        self.assert_request_made(
-            method=RequestMethod.DELETE,
-            path=f"{self.base_path}/files/{file_id}",
-        )

evo_files-0.1.0/tests/test_file_io.py

@@ -1,152 +0,0 @@
-#  Copyright © 2025 Bentley Systems, Incorporated
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-
-import json
-from uuid import UUID
-
-from data import load_test_data
-from evo.common import ServiceUser
-from evo.common.test_tools import TestWithConnector, TestWithDownloadHandler, TestWithUploadHandler, utc_datetime
-from evo.files import FileAPIDownload, FileAPIUpload, FileMetadata
-
-TEST_DATA = """
-x,y,z
-10689.54607,100813.2874,442.172449
-10690.87819,100812.6204,437.399555
-10692.21062,100811.9502,432.627182
-10693.54337,100811.277,427.85533
-10694.87638,100810.6009,423.083966
-10696.06353,100809.9976,418.831067
-10725.47983,100777.2912,448.471682
-10727.51038,100775.9784,444.022761
-10729.54666,100774.6657,439.576449
-10731.58199,100773.3566,435.128615
-""".lstrip().encode("utf-8")
-
-FILE_ID = UUID(int=5)
-VERSION_ID = "123456"
-INITIAL_URL = "https://unit.test/initial/url"
-
-
-class TestFileAPIDownload(TestWithConnector, TestWithDownloadHandler):
-    def setUp(self) -> None:
-        TestWithConnector.setUp(self)
-        TestWithDownloadHandler.setUp(self)
-        self.setup_download_handler(TEST_DATA)
-        self.metadata = FileMetadata(
-            environment=self.environment,
-            id=FILE_ID,
-            name="file.csv",
-            created_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            created_at=utc_datetime(2020, 1, 1, 1, 30),
-            modified_by=ServiceUser(
-                id=UUID(int=16),
-                name="x y",
-                email="test@example.com",
-            ),
-            modified_at=utc_datetime(2020, 1, 1, 1, 30),
-            parent="/some/path",
-            version_id=VERSION_ID,
-            size=len(TEST_DATA),
-        )
-        self.download = FileAPIDownload(connector=self.connector, metadata=self.metadata, initial_url=INITIAL_URL)
-
-    def test_label(self) -> None:
-        expected = f"{self.metadata.id}?version_id={self.metadata.version_id}"
-        self.assertEqual(expected, self.download.label)
-
-    def test_metadata(self) -> None:
-        self.assertEqual(self.metadata, self.download.metadata)
-
-    def test_get_cache_location(self) -> None:
-        expected = self.cache.get_location(self.environment, "filev2") / str(FILE_ID) / VERSION_ID / self.metadata.name
-        self.assertEqual(expected, self.download._get_cache_location(self.cache))
-
-    async def test_get_download_url(self) -> None:
-        # Test the initial URL is used first.
-        first = await self.download.get_download_url()
-        self.assertEqual(INITIAL_URL, first)
-
-        # No requests should be made when using the initial URL.
-        self.transport.assert_no_requests()
-
-        # Test that a new URL is generated when the initial URL is used up.
-        get_file_response = load_test_data("get_file.json")
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(get_file_response), headers={"Content-Type": "application/json"}
-        ):
-            second = await self.download.get_download_url()
-        self.assertEqual(get_file_response["download"], second)
-
-    async def test_download_to_path(self) -> None:
-        dest = self.cache.root / "test_download_to_path.csv"
-        await self.download.download_to_path(dest, self.transport)
-
-        # Check the file was downloaded correctly.
-        self.assertEqual(TEST_DATA, dest.read_bytes())
-        self.assert_download_requests(INITIAL_URL)
-
-    async def test_download_to_cache(self) -> None:
-        dest = await self.download.download_to_cache(self.cache, self.transport)
-
-        # Check the download location is correct.
-        expected = self.cache.get_location(self.environment, "filev2") / str(FILE_ID) / VERSION_ID / self.metadata.name
-        self.assertEqual(expected, dest)
-
-        # Check the file was downloaded correctly.
-        self.assertEqual(TEST_DATA, dest.read_bytes())
-        self.assert_download_requests(INITIAL_URL)
-
-
-class TestFileAPIUpload(TestWithConnector, TestWithUploadHandler):
-    def setUp(self) -> None:
-        TestWithConnector.setUp(self)
-        TestWithUploadHandler.setUp(self)
-        self.upload = FileAPIUpload(
-            connector=self.connector,
-            environment=self.environment,
-            file_id=FILE_ID,
-            version_id=VERSION_ID,
-            initial_url=INITIAL_URL,
-        )
-
-    def test_label(self) -> None:
-        expected = f"{FILE_ID}?version_id={VERSION_ID}"
-        self.assertEqual(expected, self.upload.label)
-
-    async def test_get_upload_url(self) -> None:
-        # Test the initial URL is used first.
-        first = await self.upload.get_upload_url()
-        self.assertEqual(INITIAL_URL, first)
-
-        # No requests should be made when using the initial URL.
-        self.transport.assert_no_requests()
-
-        # Test that a new URL is generated when the initial URL is used up.
-        update_file_response = load_test_data("update_file.json")
-        with self.transport.set_http_response(
-            status_code=200, content=json.dumps(update_file_response), headers={"Content-Type": "application/json"}
-        ):
-            second = await self.upload.get_upload_url()
-        self.assertEqual(update_file_response["upload"], second)
-
-    async def test_upload_from_path(self) -> None:
-        source = self.cache.root / "test_upload_from_path.csv"
-        source.write_bytes(TEST_DATA)
-        await self.upload.upload_from_path(source, self.transport)
-
-        # Check the file was uploaded correctly.
-        uploaded = await self.handler.get_committed()
-        self.assertEqual(TEST_DATA, uploaded)

evo_files-0.1.0/tests/test_make_name_safe.py

@@ -1,54 +0,0 @@
-#  Copyright © 2025 Bentley Systems, Incorporated
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-
-import unittest
-
-from evo.files.io import _INVALID_NAMES, _make_name_safe
-
-
-class TestMakeNameSafe(unittest.TestCase):
-    def test_invalid_characters(self):
-        self.assertEqual(_make_name_safe("test<name>"), "test%3Cname%3E")
-        self.assertEqual(_make_name_safe("test:name"), "test%3Aname")
-        self.assertEqual(_make_name_safe("test/name"), "test%2Fname")
-        self.assertEqual(_make_name_safe("test\\name"), "test%5Cname")
-        self.assertEqual(_make_name_safe("test|name"), "test%7Cname")
-        self.assertEqual(_make_name_safe("test?name"), "test%3Fname")
-        self.assertEqual(_make_name_safe("test*name"), "test%2Aname")
-
-    def test_invalid_trailing_characters(self):
-        self.assertEqual(_make_name_safe("test "), "test%20")
-        self.assertEqual(_make_name_safe("test."), "test%2E")
-
-    def test_reserved_names(self):
-        for name in _INVALID_NAMES:
-            self.assertEqual(_make_name_safe(name), name + "_")
-            self.assertEqual(_make_name_safe(name + ".txt"), name + "_.txt")
-
-    def test_valid_names(self):
-        self.assertEqual(_make_name_safe("test"), "test")
-        self.assertEqual(_make_name_safe("test123"), "test123")
-        self.assertEqual(_make_name_safe("test_name"), "test_name")
-
-    def test_leading_trailing_special_characters(self):
-        self.assertEqual(_make_name_safe("<test>"), "%3Ctest%3E")
-
-    def test_leading_trailing_reserved_names(self):
-        self.assertEqual(_make_name_safe("CONtestCON"), "CONtestCON")
-
-    def test_mixed_valid_invalid_characters(self):
-        self.assertEqual(_make_name_safe("te<st>na:me"), "te%3Cst%3Ena%3Ame")
-
-    def test_empty_string(self):
-        self.assertEqual(_make_name_safe(""), "")
-
-    def test_only_special_characters(self):
-        self.assertEqual(_make_name_safe('<>:"/\\|?*'), "%3C%3E%3A%22%2F%5C%7C%3F%2A")