From 88c0b907e76bccfe1a25dc6580272b07aebd45d6 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Sat, 10 Aug 2019 11:28:00 +0200 Subject: [PATCH] Refs #30461 -- Added django.utils._os.to_path(). --- django/utils/_os.py | 10 ++++++++++ tests/utils_tests/test_os_utils.py | 14 +++++++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/django/utils/_os.py b/django/utils/_os.py index c901d584c1a..b2a2a9d4266 100644 --- a/django/utils/_os.py +++ b/django/utils/_os.py @@ -1,6 +1,7 @@ import os import tempfile from os.path import abspath, dirname, join, normcase, sep +from pathlib import Path from django.core.exceptions import SuspiciousFileOperation @@ -47,3 +48,12 @@ def symlinks_supported(): except (OSError, NotImplementedError): supported = False return supported + + +def to_path(value): + """Convert value to a pathlib.Path instance, if not already a Path.""" + if isinstance(value, Path): + return value + elif not isinstance(value, str): + raise TypeError('Invalid path type: %s' % type(value).__name__) + return Path(value) diff --git a/tests/utils_tests/test_os_utils.py b/tests/utils_tests/test_os_utils.py index e1bc3e5d839..76c0eda944e 100644 --- a/tests/utils_tests/test_os_utils.py +++ b/tests/utils_tests/test_os_utils.py @@ -1,8 +1,9 @@ import os import unittest +from pathlib import Path from django.core.exceptions import SuspiciousFileOperation -from django.utils._os import safe_join +from django.utils._os import safe_join, to_path class SafeJoinTests(unittest.TestCase): @@ -29,3 +30,14 @@ class SafeJoinTests(unittest.TestCase): def test_parent_path(self): with self.assertRaises(SuspiciousFileOperation): safe_join("/abc/", "../def") + + +class ToPathTests(unittest.TestCase): + def test_to_path(self): + for path in ('/tmp/some_file.txt', Path('/tmp/some_file.txt')): + with self.subTest(path): + self.assertEqual(to_path(path), Path('/tmp/some_file.txt')) + + def test_to_path_invalid_value(self): + with self.assertRaises(TypeError): + to_path(42)