Skip to content

Commit

Permalink
fix: add file handling to URL fields (#2800)
Browse files Browse the repository at this point in the history
* fix: add `file` handling to URL fields

Requires a modicum of special handling due to hostnames being
optional.

Fixes: Issue #2249

* Add more tests cases; update changelog

---------

Co-authored-by: Steven Loria <[email protected]>
  • Loading branch information
0xDEC0DE and sloria authored Jan 23, 2025
1 parent ea26aeb commit 76bc28a
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 3 deletions.
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,4 @@ Contributors (chronological)
- Peter C `@somethingnew2-0 <https://github.com/somethingnew2-0>`_
- Marcel Jackwerth `@mrcljx` <https://github.com/mrcljx>`_
- Fares Abubaker `@Fares-Abubaker <https://github.com/Fares-Abubaker>`_
- Nicolas Simonds `@0xDEC0DE <https://github.com/0xDEC0DE>`_
6 changes: 4 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Bug fixes:
- Correctly handle multiple `@post_load <marshmallow.post_load>` methods where one method appends to
the data and another passes ``pass_original=True`` (:issue:`1755`).
Thanks :user:`ghostwheel42` for reporting.
- ``URL`` fields now properly validate ``file`` paths (:issue:`2249`).
Thanks :user:`0xDEC0DE` for reporting and fixing.

Documentation:

Expand All @@ -25,8 +27,8 @@ Documentation:

Deprecations:

- The ``ordered`` `class Meta <marshmallow.Schema.Meta>` option is deprecated (:issue:`2146`, :pr:`2762`).
Field order is already preserved by default. Set `marshmallow.Schema.dict_class` to `collections.OrderedDict`
- The ``ordered`` `class Meta <marshmallow.Schema.Meta>` option is deprecated (:issue:`2146`, :pr:`2762`).
Field order is already preserved by default. Set `marshmallow.Schema.dict_class` to `collections.OrderedDict`
to maintain the previous behavior.

3.25.1 (2025-01-11)
Expand Down
10 changes: 9 additions & 1 deletion src/marshmallow/validate.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ def __call__(self, value: str) -> str:
raise ValidationError(message)

# Check first if the scheme is valid
scheme = None
if "://" in value:
scheme = value.split("://")[0].lower()
if scheme not in self.schemes:
Expand All @@ -225,7 +226,14 @@ def __call__(self, value: str) -> str:
relative=self.relative, absolute=self.absolute, require_tld=self.require_tld
)

if not regex.search(value):
# Hostname is optional for file URLS. If absent it means `localhost`.
# Fill it in for the validation if needed
if scheme == "file" and value.startswith("file:///"):
matched = regex.search(value.replace("file:///", "file://localhost/", 1))
else:
matched = regex.search(value)

if not matched:
raise ValidationError(message)

return value
Expand Down
34 changes: 34 additions & 0 deletions tests/test_validate.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,40 @@ def test_url_custom_scheme():
assert validator(url) == url


@pytest.mark.parametrize(
"valid_url",
(
"file:///tmp/tmp1234",
"file://localhost/tmp/tmp1234",
"file:///C:/Users/test/file.txt",
"file://localhost/C:/Program%20Files/file.exe",
"file:///home/user/documents/test.pdf",
"file:///tmp/test%20file.txt",
"file:///",
"file://localhost/",
),
)
def test_url_accepts_valid_file_urls(valid_url):
validator = validate.URL(schemes={"file"})
assert validator(valid_url) == valid_url


@pytest.mark.parametrize(
"invalid_url",
(
"file://",
"file:/tmp/file.txt",
"file:tmp/file.txt",
"file://hostname/path",
"file:///tmp/test file.txt",
),
)
def test_url_rejects_invalid_file_urls(invalid_url):
validator = validate.URL(schemes={"file"})
with pytest.raises(ValidationError, match="Not a valid URL."):
assert validator(invalid_url)


def test_url_relative_and_custom_schemes():
validator = validate.URL(relative=True)
# By default, ws not allowed
Expand Down

0 comments on commit 76bc28a

Please sign in to comment.