Files.com 1.6.484__tar.gz → 1.6.486__tar.gz

{files_com-1.6.484/files_com.egg-info → files_com-1.6.486}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.484
+Version: 1.6.486
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -384,16 +384,16 @@ except files_sdk.error.Error as err:
 
 ## Paths
 
-Working with paths in Files.com involves several important considerations. Understanding how path comparisons are applied helps developers ensure consistency and accuracy across all interactions with the platform.
+Files.com preserves the spelling of file and folder paths while comparing them using shared case and Unicode rules. Use the SDK comparison helpers when matching paths locally.
 <div></div>
 
 ### Capitalization
 
-Files.com compares paths in a **case-insensitive** manner. This means path segments are treated as equivalent regardless of letter casing.
+Files.com uses case-insensitive path matching based on its fixed Unicode comparison map.
 
-For example, all of the following resolve to the same internal path:
+For example, the following paths have the same comparison key:
 
-| Path Variant                          | Interpreted As              |
+| Path Variant                          | Comparison Key              |
 |---------------------------------------|------------------------------|
 | `Documents/Reports/Q1.pdf`            | `documents/reports/q1.pdf`  |
 | `documents/reports/q1.PDF`            | `documents/reports/q1.pdf`  |
@@ -420,32 +420,27 @@ if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
 
 ### Slashes
 
-All path parameters in Files.com (API, SDKs, CLI, automations, integrations) must **omit leading and trailing slashes**. Paths are always treated as **absolute and slash-delimited**, so only internal `/` separators are used and never at the start or end of the string.
+Use `/` between folder and file names, without leading or trailing slashes. SDK normalization helpers convert backslashes to `/`, remove duplicate separators, and discard exact `.` and `..` components. Discarding `..` leaves the preceding folder name intact.
 
-####  Path Slash Examples
-| Path                              | Valid? | Notes                         |
-|-----------------------------------|--------|-------------------------------|
-| `folder/subfolder/file.txt`       |   ✅   | Correct, internal separators only |
-| `/folder/subfolder/file.txt`      |   ❌   | Leading slash not allowed     |
-| `folder/subfolder/file.txt/`      |   ❌   | Trailing slash not allowed    |
-| `//folder//file.txt`              |   ❌   | Duplicate separators not allowed |
+| Input | Normalized path |
+|-------|-----------------|
+| `folder/subfolder/file.txt` | `folder/subfolder/file.txt` |
+| `/folder/subfolder/file.txt` | `folder/subfolder/file.txt` |
+| `folder/subfolder/file.txt/` | `folder/subfolder/file.txt` |
+| `//folder//file.txt` | `folder/file.txt` |
+| `folder/../file.txt` | `folder/file.txt` |
 
 <div></div>
 
-### Unicode Normalization
+### Unicode and Path Comparison
 
-Files.com normalizes all paths using [Unicode NFC (Normalization Form C)](https://www.unicode.org/reports/tr15/#Norm_Forms) before comparison. This ensures consistency across different representations of the same characters.
+Files.com compares paths using a fixed mapping shared by the server and SDKs. It treats case and many accent differences as equivalent: `Résumé.txt` and `resume.txt` identify the same file, as do `q` followed by a combining acute accent and `q`. The mapping also handles other equivalences, such as Hiragana and Katakana. Lowercasing or applying a standard Unicode normalization form alone does not reproduce these rules.
 
-For example, the following two paths are treated as equivalent after NFC normalization:
+SDK comparison helpers normalize path separators and dot segments, then apply the bundled [versioned comparison map](https://github.com/Files-com/files-sdk-javascript/blob/master/shared/path_comparison.json). The [shared examples](https://github.com/Files-com/files-sdk-javascript/blob/master/shared/comparison_examples.json) give exact comparison results for integrations that implement their own matching. The map uses hexadecimal Unicode scalar values as keys: a missing entry preserves the character, an empty replacement removes it, and other replacements may contain several characters. Apply each replacement once without normalizing or lowercasing the result again.
 
-| Input                                  | Normalized Form       |
-|----------------------------------------|------------------------|
-| `uploads/\u0065\u0301.txt`             | `uploads/é.txt`        |
-| `docs/Café/Report.txt`                 | `docs/Café/Report.txt` |
+Use comparison results only for matching. Send the original path spelling in API requests and preserve it for display and local filenames; comparison results can have a different spelling or length.
 
-- All input must be UTF‑8 encoded.
-- Precomposed and decomposed characters are unified.
-- This affects search, deduplication, and comparisons across SDKs.
+Trailing whitespace is significant for comparison. `report.txt` and `report.txt ` are different file paths, and SDK helpers preserve spaces, tabs, and newlines. Folder names cannot end in whitespace. See [Unicode Normalization](https://www.files.com/docs/files-and-folders/file-system-semantics/unicode-normalization) for the complete path rules.
 
 <div></div>
 

{files_com-1.6.484 → files_com-1.6.486}/README.md

@@ -372,16 +372,16 @@ except files_sdk.error.Error as err:
 
 ## Paths
 
-Working with paths in Files.com involves several important considerations. Understanding how path comparisons are applied helps developers ensure consistency and accuracy across all interactions with the platform.
+Files.com preserves the spelling of file and folder paths while comparing them using shared case and Unicode rules. Use the SDK comparison helpers when matching paths locally.
 <div></div>
 
 ### Capitalization
 
-Files.com compares paths in a **case-insensitive** manner. This means path segments are treated as equivalent regardless of letter casing.
+Files.com uses case-insensitive path matching based on its fixed Unicode comparison map.
 
-For example, all of the following resolve to the same internal path:
+For example, the following paths have the same comparison key:
 
-| Path Variant                          | Interpreted As              |
+| Path Variant                          | Comparison Key              |
 |---------------------------------------|------------------------------|
 | `Documents/Reports/Q1.pdf`            | `documents/reports/q1.pdf`  |
 | `documents/reports/q1.PDF`            | `documents/reports/q1.pdf`  |
@@ -408,32 +408,27 @@ if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
 
 ### Slashes
 
-All path parameters in Files.com (API, SDKs, CLI, automations, integrations) must **omit leading and trailing slashes**. Paths are always treated as **absolute and slash-delimited**, so only internal `/` separators are used and never at the start or end of the string.
+Use `/` between folder and file names, without leading or trailing slashes. SDK normalization helpers convert backslashes to `/`, remove duplicate separators, and discard exact `.` and `..` components. Discarding `..` leaves the preceding folder name intact.
 
-####  Path Slash Examples
-| Path                              | Valid? | Notes                         |
-|-----------------------------------|--------|-------------------------------|
-| `folder/subfolder/file.txt`       |   ✅   | Correct, internal separators only |
-| `/folder/subfolder/file.txt`      |   ❌   | Leading slash not allowed     |
-| `folder/subfolder/file.txt/`      |   ❌   | Trailing slash not allowed    |
-| `//folder//file.txt`              |   ❌   | Duplicate separators not allowed |
+| Input | Normalized path |
+|-------|-----------------|
+| `folder/subfolder/file.txt` | `folder/subfolder/file.txt` |
+| `/folder/subfolder/file.txt` | `folder/subfolder/file.txt` |
+| `folder/subfolder/file.txt/` | `folder/subfolder/file.txt` |
+| `//folder//file.txt` | `folder/file.txt` |
+| `folder/../file.txt` | `folder/file.txt` |
 
 <div></div>
 
-### Unicode Normalization
+### Unicode and Path Comparison
 
-Files.com normalizes all paths using [Unicode NFC (Normalization Form C)](https://www.unicode.org/reports/tr15/#Norm_Forms) before comparison. This ensures consistency across different representations of the same characters.
+Files.com compares paths using a fixed mapping shared by the server and SDKs. It treats case and many accent differences as equivalent: `Résumé.txt` and `resume.txt` identify the same file, as do `q` followed by a combining acute accent and `q`. The mapping also handles other equivalences, such as Hiragana and Katakana. Lowercasing or applying a standard Unicode normalization form alone does not reproduce these rules.
 
-For example, the following two paths are treated as equivalent after NFC normalization:
+SDK comparison helpers normalize path separators and dot segments, then apply the bundled [versioned comparison map](https://github.com/Files-com/files-sdk-javascript/blob/master/shared/path_comparison.json). The [shared examples](https://github.com/Files-com/files-sdk-javascript/blob/master/shared/comparison_examples.json) give exact comparison results for integrations that implement their own matching. The map uses hexadecimal Unicode scalar values as keys: a missing entry preserves the character, an empty replacement removes it, and other replacements may contain several characters. Apply each replacement once without normalizing or lowercasing the result again.
 
-| Input                                  | Normalized Form       |
-|----------------------------------------|------------------------|
-| `uploads/\u0065\u0301.txt`             | `uploads/é.txt`        |
-| `docs/Café/Report.txt`                 | `docs/Café/Report.txt` |
+Use comparison results only for matching. Send the original path spelling in API requests and preserve it for display and local filenames; comparison results can have a different spelling or length.
 
-- All input must be UTF‑8 encoded.
-- Precomposed and decomposed characters are unified.
-- This affects search, deduplication, and comparisons across SDKs.
+Trailing whitespace is significant for comparison. `report.txt` and `report.txt ` are different file paths, and SDK helpers preserve spaces, tabs, and newlines. Folder names cannot end in whitespace. See [Unicode Normalization](https://www.files.com/docs/files-and-folders/file-system-semantics/unicode-normalization) for the complete path rules.
 
 <div></div>
 

files_com-1.6.486/_VERSION

@@ -0,0 +1 @@
+1.6.486

{files_com-1.6.484 → files_com-1.6.486/files_com.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.484
+Version: 1.6.486
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -384,16 +384,16 @@ except files_sdk.error.Error as err:
 
 ## Paths
 
-Working with paths in Files.com involves several important considerations. Understanding how path comparisons are applied helps developers ensure consistency and accuracy across all interactions with the platform.
+Files.com preserves the spelling of file and folder paths while comparing them using shared case and Unicode rules. Use the SDK comparison helpers when matching paths locally.
 <div></div>
 
 ### Capitalization
 
-Files.com compares paths in a **case-insensitive** manner. This means path segments are treated as equivalent regardless of letter casing.
+Files.com uses case-insensitive path matching based on its fixed Unicode comparison map.
 
-For example, all of the following resolve to the same internal path:
+For example, the following paths have the same comparison key:
 
-| Path Variant                          | Interpreted As              |
+| Path Variant                          | Comparison Key              |
 |---------------------------------------|------------------------------|
 | `Documents/Reports/Q1.pdf`            | `documents/reports/q1.pdf`  |
 | `documents/reports/q1.PDF`            | `documents/reports/q1.pdf`  |
@@ -420,32 +420,27 @@ if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
 
 ### Slashes
 
-All path parameters in Files.com (API, SDKs, CLI, automations, integrations) must **omit leading and trailing slashes**. Paths are always treated as **absolute and slash-delimited**, so only internal `/` separators are used and never at the start or end of the string.
+Use `/` between folder and file names, without leading or trailing slashes. SDK normalization helpers convert backslashes to `/`, remove duplicate separators, and discard exact `.` and `..` components. Discarding `..` leaves the preceding folder name intact.
 
-####  Path Slash Examples
-| Path                              | Valid? | Notes                         |
-|-----------------------------------|--------|-------------------------------|
-| `folder/subfolder/file.txt`       |   ✅   | Correct, internal separators only |
-| `/folder/subfolder/file.txt`      |   ❌   | Leading slash not allowed     |
-| `folder/subfolder/file.txt/`      |   ❌   | Trailing slash not allowed    |
-| `//folder//file.txt`              |   ❌   | Duplicate separators not allowed |
+| Input | Normalized path |
+|-------|-----------------|
+| `folder/subfolder/file.txt` | `folder/subfolder/file.txt` |
+| `/folder/subfolder/file.txt` | `folder/subfolder/file.txt` |
+| `folder/subfolder/file.txt/` | `folder/subfolder/file.txt` |
+| `//folder//file.txt` | `folder/file.txt` |
+| `folder/../file.txt` | `folder/file.txt` |
 
 <div></div>
 
-### Unicode Normalization
+### Unicode and Path Comparison
 
-Files.com normalizes all paths using [Unicode NFC (Normalization Form C)](https://www.unicode.org/reports/tr15/#Norm_Forms) before comparison. This ensures consistency across different representations of the same characters.
+Files.com compares paths using a fixed mapping shared by the server and SDKs. It treats case and many accent differences as equivalent: `Résumé.txt` and `resume.txt` identify the same file, as do `q` followed by a combining acute accent and `q`. The mapping also handles other equivalences, such as Hiragana and Katakana. Lowercasing or applying a standard Unicode normalization form alone does not reproduce these rules.
 
-For example, the following two paths are treated as equivalent after NFC normalization:
+SDK comparison helpers normalize path separators and dot segments, then apply the bundled [versioned comparison map](https://github.com/Files-com/files-sdk-javascript/blob/master/shared/path_comparison.json). The [shared examples](https://github.com/Files-com/files-sdk-javascript/blob/master/shared/comparison_examples.json) give exact comparison results for integrations that implement their own matching. The map uses hexadecimal Unicode scalar values as keys: a missing entry preserves the character, an empty replacement removes it, and other replacements may contain several characters. Apply each replacement once without normalizing or lowercasing the result again.
 
-| Input                                  | Normalized Form       |
-|----------------------------------------|------------------------|
-| `uploads/\u0065\u0301.txt`             | `uploads/é.txt`        |
-| `docs/Café/Report.txt`                 | `docs/Café/Report.txt` |
+Use comparison results only for matching. Send the original path spelling in API requests and preserve it for display and local filenames; comparison results can have a different spelling or length.
 
-- All input must be UTF‑8 encoded.
-- Precomposed and decomposed characters are unified.
-- This affects search, deduplication, and comparisons across SDKs.
+Trailing whitespace is significant for comparison. `report.txt` and `report.txt ` are different file paths, and SDK helpers preserve spaces, tabs, and newlines. Folder names cannot end in whitespace. See [Unicode Normalization](https://www.files.com/docs/files-and-folders/file-system-semantics/unicode-normalization) for the complete path rules.
 
 <div></div>
 

{files_com-1.6.484 → files_com-1.6.486}/files_com.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ files_sdk/api.py
 files_sdk/api_client.py
 files_sdk/error.py
 files_sdk/list_obj.py
+files_sdk/path_comparison.json
 files_sdk/path_util.py
 files_sdk/util.py
 files_sdk/../README.md
@@ -300,6 +301,7 @@ tests/test_sync.py
 tests/test_sync_log.py
 tests/test_sync_run.py
 tests/test_sync_run_live_transfer.py
+tests/test_transfer_privacy.py
 tests/test_usage_by_top_level_dir.py
 tests/test_usage_daily_snapshot.py
 tests/test_usage_snapshot.py

{files_com-1.6.484 → files_com-1.6.486}/files_sdk/__init__.py

@@ -320,7 +320,7 @@ source_ip = None
 workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.484"
+version = "1.6.486"
 
 __version__ = version
 

{files_com-1.6.484 → files_com-1.6.486}/files_sdk/api_client.py

@@ -65,7 +65,7 @@ class ApiClient:
             headers = {}
         req = requests.Request(method, url=url, headers=headers, data=body)
 
-        response = self.execute_request_with_auto_retry(req)
+        response = self.execute_request_with_auto_retry(req, is_transfer=True)
         return response
 
     def send_request(
@@ -166,6 +166,7 @@ class ApiClient:
         return response
 
     def stream_download(self, uri, io, is_string_io=False):
+        util.log_debug("Download request", url=uri)
         # NOTE the stream=True parameter below
         try:
             with requests.get(
@@ -187,9 +188,14 @@ class ApiClient:
             requests.exceptions.ChunkedEncodingError,
         ) as e:
             raise self.handle_network_error(e, e.request, 0) from None
+        except requests.exceptions.HTTPError as e:
+            util.log_debug("Transfer error details", error_message=e)
+            raise APIError(
+                "Transfer request failed", http_status=e.response.status_code
+            ) from None
 
     def execute_request_with_auto_retry(
-        self, request, skip_body_logging=False
+        self, request, skip_body_logging=False, is_transfer=False
     ):
         for try_num in range(0, files_sdk.max_network_retries):
             response = None
@@ -227,7 +233,9 @@ class ApiClient:
 
                 if try_num + 1 == files_sdk.max_network_retries:
                     if response is not None:
-                        self.handle_error_response(response)
+                        self.handle_error_response(
+                            response, is_transfer=is_transfer
+                        )
                     else:
                         raise self.handle_network_error(
                             e, request, try_num
@@ -296,7 +304,7 @@ class ApiClient:
             msg += " Additional Information: {}".format(extra_info)
         return APIError(msg)
 
-    def handle_error_response(self, response):
+    def handle_error_response(self, response, is_transfer=False):
         error_data = None
 
         try:
@@ -317,18 +325,27 @@ class ApiClient:
             if not error_data:
                 raise Error("Unknown error")
         except Error:
+            if is_transfer:
+                raise APIError(
+                    "Transfer request failed", http_status=response.status_code
+                ) from None
             raise self.general_api_error(response, "Unknown error")
 
-        error = self.specific_api_error(response, error_data)
+        error = self.specific_api_error(
+            response, error_data, is_transfer=is_transfer
+        )
 
         error.response = response
-        raise error
+        raise error from None
 
-    def specific_api_error(self, response, error_data):
+    def specific_api_error(self, response, error_data, is_transfer=False):
         import files_sdk.error
 
+        message = (
+            "Transfer request failed" if is_transfer else error_data["message"]
+        )
         util.log_error(
-            "API error", status=response.status_code, error_message=error_data
+            "API error", status=response.status_code, error_message=message
         )
 
         opts = {
@@ -344,32 +361,31 @@ class ApiClient:
             "".join(list(map(str.capitalize, error_type.split("-")))) + "Error"
         )
         try:
-            return getattr(files_sdk.error, error_class_name)(
-                error_data["message"], **opts
-            )
+            return getattr(files_sdk.error, error_class_name)(message, **opts)
         except AttributeError:
-            return APIError(error_data["message"], **opts)
+            return APIError(message, **opts)
 
     def handle_network_error(self, error, request, num_retries):
-        util.log_error("Network error", error_message=error)
+        util.log_error("Network error", error_type=type(error).__name__)
+        util.log_debug("Network error details", error_message=error)
         msg = "Could not connect to Files.com at URL {}. Please check your internet connection and try again. If this problem persists, you should check Files.com's service status at https://status.files.com, or contact your primary account representative.".format(
             files_sdk.base_url
         )
         if num_retries > 0:
             msg += " Request was retried {} times.".format(num_retries)
-        msg += "\n\n(Network error: {})".format(error)
+        msg += "\n\n(Network error: {})".format(type(error).__name__)
 
         return APIConnectionError(msg)
 
     def log_request(self, request, num_retries):
         util.log_info(
-            "Request",
-            method=request.method,
-            num_retries=num_retries,
-            url=request.url,
+            "Request", method=request.method, num_retries=num_retries
         )
         util.log_debug(
-            "Request details", body=request.data, query_params=request.params
+            "Request details",
+            url=request.url,
+            body=request.data,
+            query_params=request.params,
         )
 
     def log_response(self, request, request_start, status, body):
@@ -377,7 +393,6 @@ class ApiClient:
             "Response",
             elapsed=(time.time() - request_start),
             method=request.method,
-            url=request.url,
             status=status,
         )
         util.log_debug("Response details", body=body)
@@ -386,7 +401,7 @@ class ApiClient:
         util.log_error(
             "Error",
             elapsed=(time.time() - request_start),
-            error_message=error,
+            error_type=type(error).__name__,
             method=request.method,
-            url=request.url,
         )
+        util.log_debug("Error details", error_message=error, url=request.url)