Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion approvaltests/asserts.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def __init__(self, file_path: str, extension: None = None) -> None:
self.file_path = file_path

@override
def get_approved_filename(self, base: str | None = None) -> str:
def get_approved_filename(self) -> str:
return self.file_path


Expand Down
4 changes: 2 additions & 2 deletions approvaltests/core/namer.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ class Namer(ABC):
RECEIVED = "." + RECEIVED_WITHOUT_DOT

@abstractmethod
def get_received_filename(self, base: str | None = None) -> str:
def get_received_filename(self) -> str:
pass

@abstractmethod
def get_approved_filename(self, base: str | None = None) -> str:
def get_approved_filename(self) -> str:
pass
10 changes: 4 additions & 6 deletions approvaltests/core/scenario_namer.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,12 @@ def get_basename(self) -> str:
return f"{basename}.{scenarios}"

@override
def get_approved_filename(self, base: str | None = None) -> str:
base = base or self.get_basename()
return self.base_namer.get_approved_filename(base)
def get_approved_filename(self) -> str:
return self.get_basename() + Namer.APPROVED + self.base_namer.extension_with_dot

@override
def get_received_filename(self, base: str | None = None) -> str:
base = base or self.get_basename()
return self.base_namer.get_received_filename(base)
def get_received_filename(self) -> str:
return self.get_basename() + Namer.RECEIVED + self.base_namer.extension_with_dot

def set_extension(self, extension: str) -> None:
self.base_namer.set_extension(extension)
4 changes: 2 additions & 2 deletions approvaltests/namer/cli_namer.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ def __init__(self, test_id: str) -> None:
self.test_id = test_id

@override
def get_received_filename(self, base: str | None = None) -> str:
def get_received_filename(self) -> str:
return f"{self.test_id}.received.txt"

@override
def get_approved_filename(self, base: str | None = None) -> str:
def get_approved_filename(self) -> str:
return f"{self.test_id}.approved.txt"

def get_basename(self) -> str:
Expand Down
4 changes: 2 additions & 2 deletions approvaltests/namer/inline_comparator.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@

class InlineComparator(Namer):
@override
def get_approved_filename(self, base: str | None = None) -> str:
def get_approved_filename(self) -> str:
file = tempfile.NamedTemporaryFile(suffix=".approved.txt", delete=False).name
docs = self.get_test_method_doc_string()
Path(file).write_text(docs, encoding="utf-8")
return file

@override
def get_received_filename(self, base: str | None = None) -> str:
def get_received_filename(self) -> str:
return tempfile.NamedTemporaryFile(suffix=".received.txt", delete=False).name

@staticmethod
Expand Down
8 changes: 4 additions & 4 deletions approvaltests/namer/namer_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ def get_basename(self) -> str:
return str(os.path.join(self.get_directory(), subdirectory, file_name))

@override
def get_received_filename(self, base: str | None = None) -> str:
base = base or self.get_basename()
def get_received_filename(self) -> str:
base = self.get_basename()
return base + Namer.RECEIVED + self.extension_with_dot

@override
def get_approved_filename(self, base: str | None = None) -> str:
base = base or self.get_basename()
def get_approved_filename(self) -> str:
base = self.get_basename()
return base + Namer.APPROVED + self.extension_with_dot

def set_extension(self, extension: str) -> None:
Expand Down
4 changes: 2 additions & 2 deletions approvaltests/namer/templated_custom_namer.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ def set_extension(self, extension_with_dot: str) -> None:
self.namer_parts.set_extension(extension_with_dot)

@override
def get_received_filename(self, base: str | None = None) -> str:
def get_received_filename(self) -> str:
return self.format_filename(self.RECEIVED_WITHOUT_DOT)

@override
def get_approved_filename(self, base: str | None = None) -> str:
def get_approved_filename(self) -> str:
return self.format_filename(self.APPROVED_WITHOUT_DOT)

def format_filename(self, approved_or_received: str) -> str:
Expand Down
12 changes: 6 additions & 6 deletions docs/explanation/namer_architecture.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```mermaid
classDiagram
class Namer {
+get_received_filename(base: Optional[str]): str
+get_approved_filename(base: Optional[str]): str
+get_received_filename(): str
+get_approved_filename(): str
}

class NamerBase {
Expand All @@ -15,8 +15,8 @@ classDiagram
+config_directory(): str
+get_config(): Dict
+get_basename(): str
+get_received_filename(base: Optional[str]): str
+get_approved_filename(base: Optional[str]): str
+get_received_filename(): str
+get_approved_filename(): str
+set_extension(extension: str): None
}
Namer <|-- NamerBase
Expand Down Expand Up @@ -44,8 +44,8 @@ classDiagram
-namer_parts: StackFrameNamer
+__init__(template: str): None
+set_extension(extension_with_dot: str): None
+get_received_filename(base: Optional[str]): str
+get_approved_filename(base: Optional[str]): str
+get_received_filename(): str
+get_approved_filename(): str
+format_filename(approved_or_received: str): str
}
Namer <|-- TemplatedCustomNamer
Expand Down
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
a
Empty file.
Empty file.
12 changes: 6 additions & 6 deletions tests/test_namer.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@ def test_basename(self) -> None:
)

def test_received_name(self) -> None:
filename = StackFrameNamer().get_received_filename("./stuff")
self.assertEqual(filename, "./stuff.received.txt")
filename = StackFrameNamer().get_received_filename()
self.assertTrue(filename.endswith("NamerTests.test_received_name.received.txt"), filename)

def test_approved_name(self) -> None:
filename = StackFrameNamer().get_approved_filename("./stuff")
self.assertEqual(filename, "./stuff.approved.txt")
filename = StackFrameNamer().get_approved_filename()
self.assertTrue(filename.endswith("NamerTests.test_approved_name.approved.txt"), filename)

def test_alternative_extension(self) -> None:
n = StackFrameNamer(extension=".html")
filename = n.get_approved_filename("./stuff")
self.assertEqual(filename, "./stuff.approved.html")
filename = n.get_approved_filename()
self.assertTrue(filename.endswith("NamerTests.test_alternative_extension.approved.html"), filename)

def test_additional_information(self) -> None:
assert_ends_with(
Expand Down
Loading