commit-editor 0.1.0__tar.gz

commit_editor-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: commit-editor
+Version: 0.1.0
+Summary: A terminal-based git commit message editor with opinionated formatting
+Author: Martin Prpič
+Author-email: Martin Prpič <martin.prpic@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Text Editors
+Requires-Dist: textual>=0.50.0
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-asyncio ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Python: >=3.11
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# Commit Editor
+
+[![PyPI](https://img.shields.io/pypi/v/commit-editor.svg)](https://pypi.python.org/pypi/commit-editor)
+[![Python](https://img.shields.io/pypi/pyversions/commit-editor.svg)](https://pypi.python.org/pypi/commit-editor)
+[![License](https://img.shields.io/pypi/l/commit-editor.svg)](https://github.com/mprpic/commit-editor/blob/main/LICENSE)
+[![CI](https://github.com/mprpic/commit-editor/workflows/CI/badge.svg)](https://github.com/mprpic/commit-editor/actions)
+
+An opinionated, terminal-based text editor for git commit messages, built
+with [Textual](https://textual.textualize.io/).
+
+- **Title length warning**: Characters beyond position 50 on the first line are highlighted in red
+- **Auto-wrap body text**: Lines in the commit body (line 3+) are automatically wrapped at 72 characters (except for
+  long strings that can't be wrapped, such as URLs)
+- **White space**: Trailing white space is automatically stripped when a file is saved; an empty newline is inserted
+  at the end of the file if not present.
+- **Signed-off-by toggle**: Quickly add or remove a `Signed-off-by` trailer with a keyboard shortcut
+- **Status bar**: Shows current cursor position (line/column) and title length with warnings
+
+## Installation
+
+```bash
+# Using uv
+uv tool install commit-editor
+
+# Using pip
+pip install commit-editor
+```
+
+### Requirements
+
+- Python 3.11 or later
+- Git (for Signed-off-by functionality)
+
+## Usage
+
+Configure `commit-editor` as your default git commit message editor:
+
+```bash
+git config --global core.editor commit-editor
+```
+
+When you run `git commit`, the editor will open automatically.
+
+`commit-editor` can also be used as a standalone tool with:
+
+```bash
+commit-editor path/to/file.txt
+```
+
+## Keyboard Shortcuts
+
+| Shortcut | Action                       |
+|----------|------------------------------|
+| `Ctrl+S` | Save the file                |
+| `Ctrl+Q` | Quit                         |
+| `Ctrl+O` | Toggle Signed-off-by trailer |
+
+## Commit Message Format
+
+This editor enforces the widely-accepted git commit message conventions:
+
+1. **Title (line 1)**: Should be 50 characters or less; characters beyond 50 are highlighted in red as a warning.
+2. **Blank line (line 2)**: Separates the title from the body.
+3. **Body (line 3+)**: Should wrap at 72 characters; long lines are wrapped automatically as you type.
+
+## Future Improvements
+
+- Support adding a "Co-authored-by" trailer for AI attribution
+- Word-level spellchecking
+- Config file support (`.commit.toml` project or global level or `pyproject.toml`); support tweaking line length limits
+- Jira (or other issue tracker) ID checking (e.g. title starts with `ABC-123: `)
+
+## License
+
+MIT

commit_editor-0.1.0/README.md

@@ -0,0 +1,75 @@
+# Commit Editor
+
+[![PyPI](https://img.shields.io/pypi/v/commit-editor.svg)](https://pypi.python.org/pypi/commit-editor)
+[![Python](https://img.shields.io/pypi/pyversions/commit-editor.svg)](https://pypi.python.org/pypi/commit-editor)
+[![License](https://img.shields.io/pypi/l/commit-editor.svg)](https://github.com/mprpic/commit-editor/blob/main/LICENSE)
+[![CI](https://github.com/mprpic/commit-editor/workflows/CI/badge.svg)](https://github.com/mprpic/commit-editor/actions)
+
+An opinionated, terminal-based text editor for git commit messages, built
+with [Textual](https://textual.textualize.io/).
+
+- **Title length warning**: Characters beyond position 50 on the first line are highlighted in red
+- **Auto-wrap body text**: Lines in the commit body (line 3+) are automatically wrapped at 72 characters (except for
+  long strings that can't be wrapped, such as URLs)
+- **White space**: Trailing white space is automatically stripped when a file is saved; an empty newline is inserted
+  at the end of the file if not present.
+- **Signed-off-by toggle**: Quickly add or remove a `Signed-off-by` trailer with a keyboard shortcut
+- **Status bar**: Shows current cursor position (line/column) and title length with warnings
+
+## Installation
+
+```bash
+# Using uv
+uv tool install commit-editor
+
+# Using pip
+pip install commit-editor
+```
+
+### Requirements
+
+- Python 3.11 or later
+- Git (for Signed-off-by functionality)
+
+## Usage
+
+Configure `commit-editor` as your default git commit message editor:
+
+```bash
+git config --global core.editor commit-editor
+```
+
+When you run `git commit`, the editor will open automatically.
+
+`commit-editor` can also be used as a standalone tool with:
+
+```bash
+commit-editor path/to/file.txt
+```
+
+## Keyboard Shortcuts
+
+| Shortcut | Action                       |
+|----------|------------------------------|
+| `Ctrl+S` | Save the file                |
+| `Ctrl+Q` | Quit                         |
+| `Ctrl+O` | Toggle Signed-off-by trailer |
+
+## Commit Message Format
+
+This editor enforces the widely-accepted git commit message conventions:
+
+1. **Title (line 1)**: Should be 50 characters or less; characters beyond 50 are highlighted in red as a warning.
+2. **Blank line (line 2)**: Separates the title from the body.
+3. **Body (line 3+)**: Should wrap at 72 characters; long lines are wrapped automatically as you type.
+
+## Future Improvements
+
+- Support adding a "Co-authored-by" trailer for AI attribution
+- Word-level spellchecking
+- Config file support (`.commit.toml` project or global level or `pyproject.toml`); support tweaking line length limits
+- Jira (or other issue tracker) ID checking (e.g. title starts with `ABC-123: `)
+
+## License
+
+MIT

commit_editor-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["uv_build>=0.9.28,<0.10.0"]
+build-backend = "uv_build"
+
+[project]
+name = "commit-editor"
+version = "0.1.0"
+description = "A terminal-based git commit message editor with opinionated formatting"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "Martin Prpič", email = "martin.prpic@gmail.com" }
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Version Control :: Git",
+    "Topic :: Text Editors",
+]
+dependencies = [
+    "textual>=0.50.0",
+]
+
+[project.scripts]
+commit-editor = "commit_editor.cli:main"
+
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-asyncio",
+    "ruff",
+]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["F", "E", "W", "I", "N"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"

commit_editor-0.1.0/src/commit_editor/__init__.py

@@ -0,0 +1,3 @@
+"""A terminal-based git commit message editor with opinionated formatting."""
+
+__version__ = "0.1.0"

commit_editor-0.1.0/src/commit_editor/app.py

@@ -0,0 +1,475 @@
+from pathlib import Path
+
+from rich.segment import Segment
+from rich.style import Style
+from rich.text import Text
+from textual import on
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.strip import Strip
+from textual.widgets import Static, TextArea
+
+from commit_editor.git import get_signed_off_by
+
+TITLE_MAX_LENGTH = 50
+BODY_MAX_LENGTH = 72
+
+
+def wrap_line(line: str, width: int = 72) -> list[str]:
+    """Wrap a single line at word boundaries to fit within width.
+
+    Args:
+        line: The line to wrap.
+        width: Maximum line width (default 72).
+
+    Returns:
+        List of wrapped lines.
+    """
+    if not line:
+        return [""]
+
+    if len(line) <= width:
+        return [line]
+
+    words = line.split(" ")
+    lines: list[str] = []
+    current_line = ""
+
+    for word in words:
+        if not word:
+            # Handle multiple spaces
+            if current_line:
+                current_line += " "
+            continue
+
+        # Check if word fits on current line
+        test_line = f"{current_line} {word}".strip() if current_line else word
+        if len(test_line) <= width:
+            current_line = test_line
+        else:
+            if current_line:
+                lines.append(current_line)
+            current_line = word
+
+    if current_line:
+        lines.append(current_line)
+
+    return lines if lines else [""]
+
+
+class CommitTextArea(TextArea):
+    """TextArea with commit-message-specific highlighting and behavior."""
+
+    DEFAULT_CSS = """
+    CommitTextArea {
+        border: none;
+        padding: 0;
+    }
+    CommitTextArea:focus {
+        border: none;
+    }
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._last_body_text = ""
+
+    def render_line(self, y: int) -> Strip:
+        """Render a line with custom highlighting for title overflow."""
+        strip = super().render_line(y)
+
+        # Only highlight overflow on the first line (title)
+        if y == 0:
+            lines = self.text.split("\n")
+            if lines:
+                title = lines[0]
+                if len(title) > TITLE_MAX_LENGTH:
+                    strip = self._highlight_title_overflow(strip, title)
+
+        return strip
+
+    @staticmethod
+    def _highlight_title_overflow(strip: Strip, title: str) -> Strip:
+        """Apply warning highlighting to title characters beyond 50."""
+        warning_style = Style(color="red", bold=True)
+
+        segments = list(strip)
+        new_segments = []
+
+        char_count = 0
+        title_started = False
+
+        for segment in segments:
+            text = segment.text
+            style = segment.style
+
+            if not title_started:
+                if text and title and text.strip() and title.startswith(text.strip()[:5]):
+                    title_started = True
+
+            if title_started and text:
+                new_text_normal = ""
+                new_text_warning = ""
+
+                for char in text:
+                    if char_count < TITLE_MAX_LENGTH:
+                        new_text_normal += char
+                    else:
+                        new_text_warning += char
+                    char_count += 1
+
+                if new_text_normal:
+                    new_segments.append(Segment(new_text_normal, style))
+                if new_text_warning:
+                    # Combine existing style with warning style
+                    combined_style = style + warning_style if style else warning_style
+                    new_segments.append(Segment(new_text_warning, combined_style))
+            else:
+                new_segments.append(segment)
+
+        return Strip(new_segments, strip.cell_length)
+
+    def wrap_current_body_line(self) -> None:
+        """Wrap the current line if it's a body line (line 3+) and exceeds 72 chars."""
+        cursor_row, cursor_col = self.cursor_location
+        lines = self.text.split("\n")
+
+        # Only wrap body lines (index 2+, which is line 3+ in 1-indexed)
+        if cursor_row < 2 or cursor_row >= len(lines):
+            return
+
+        current_line = lines[cursor_row]
+
+        # Only wrap if line exceeds the limit
+        if len(current_line) <= BODY_MAX_LENGTH:
+            return
+
+        # Wrap the line
+        wrapped = wrap_line(current_line, BODY_MAX_LENGTH)
+
+        if len(wrapped) <= 1:
+            return
+
+        # Replace the current line with wrapped content
+        lines[cursor_row : cursor_row + 1] = wrapped
+        new_text = "\n".join(lines)
+
+        # Calculate new cursor position
+        # If cursor was beyond the wrap point, move to next line
+        if cursor_col > len(wrapped[0]):
+            new_row = cursor_row + 1
+            new_col = cursor_col - len(wrapped[0]) - 1  # -1 for the space that became newline
+            new_col = max(0, min(new_col, len(wrapped[1]) if len(wrapped) > 1 else 0))
+        else:
+            new_row = cursor_row
+            new_col = cursor_col
+
+        self.load_text(new_text)
+        self.cursor_location = (new_row, new_col)
+
+    def get_title_length(self) -> int:
+        """Get the length of the title (first line)."""
+        lines = self.text.split("\n")
+        return len(lines[0]) if lines else 0
+
+    def get_cursor_position(self) -> tuple[int, int]:
+        """Get the current cursor position (1-indexed line, 1-indexed column)."""
+        row, col = self.cursor_location
+        return row + 1, col + 1
+
+
+class StatusBar(Static):
+    """Status bar showing cursor position and title length."""
+
+    DEFAULT_CSS = """
+    StatusBar {
+        height: 1;
+        background: $primary;
+        color: $text;
+        padding: 0 1;
+    }
+
+    StatusBar .warning {
+        color: $error;
+    }
+    """
+
+    def update_status(self, line: int, col: int, title_length: int, dirty: bool) -> None:
+        """Update the status bar content."""
+        dirty_marker = " \\[modified]" if dirty else ""
+
+        if title_length > TITLE_MAX_LENGTH:
+            title_display = f"[bold red]Title: {title_length}[/bold red]"
+        else:
+            title_display = f"Title: {title_length}"
+
+        left = f"Ln {line}, Col {col} | {title_display}{dirty_marker}"
+        hints = "^S Save  ^Q Quit  ^O Sign-off"
+        left_width = len(Text.from_markup(left).plain)
+        # Account for padding on both sides
+        gap = (self.size.width - 2) - left_width - len(hints)
+        if gap >= 2:
+            self.update(f"{left}{' ' * gap}[dim]{hints}[/dim]")
+        else:
+            self.update(left)
+
+
+class MessageBar(Static):
+    """Message bar for showing status messages and prompts."""
+
+    DEFAULT_CSS = """
+    MessageBar {
+        height: 1;
+        background: $surface;
+        color: $text;
+        padding: 0 1;
+    }
+
+    MessageBar.error {
+        color: $error;
+    }
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.message = ""
+
+    def show_message(self, message: str, error: bool = False) -> None:
+        """Show a status message."""
+        self.message = message
+        if error:
+            self.add_class("error")
+        else:
+            self.remove_class("error")
+        self.update(message)
+
+    def show_prompt(self, message: str) -> None:
+        """Show a prompt message."""
+        self.message = message
+        self.remove_class("error")
+        self.update(message)
+
+    def clear(self) -> None:
+        """Clear the message bar content."""
+        self.message = ""
+        self.remove_class("error")
+        self.update("")
+
+
+class CommitEditorApp(App):
+    """A terminal-based git commit message editor."""
+
+    TITLE = "commit-editor"
+
+    BINDINGS = [
+        Binding("ctrl+s", "save", "Save", show=True),
+        Binding("ctrl+q", "quit_app", "Quit", show=True),
+        Binding("ctrl+o", "toggle_signoff", "Sign-off", show=True),
+    ]
+
+    DEFAULT_CSS = """
+    Screen {
+        layout: vertical;
+    }
+
+    CommitTextArea {
+        height: 1fr;
+    }
+    """
+
+    def __init__(self, filename: Path):
+        super().__init__()
+        self.filename = filename
+        self.dirty = False
+        self._original_content = ""
+        self._prompt_mode: str | None = None  # Track active prompt type
+
+    def compose(self) -> ComposeResult:
+        yield CommitTextArea(id="editor", show_line_numbers=True, highlight_cursor_line=True)
+        yield StatusBar(id="status")
+        yield MessageBar(id="message")
+
+    def on_mount(self) -> None:
+        """Load file content on startup."""
+        editor = self.query_one("#editor", CommitTextArea)
+
+        content = self.filename.read_text()
+        self._original_content = content
+        editor.load_text(content)
+        editor.focus()
+
+        self._update_status_bar()
+
+    def check_action(self, action: str, parameters: tuple) -> bool | None:
+        """Disable editor actions when in prompt mode."""
+        if self._prompt_mode is not None:
+            # Allow only prompt-related actions
+            if action in ("confirm_quit", "cancel_quit"):
+                return True
+            return False
+        return True
+
+    def action_confirm_quit(self) -> None:
+        """Confirm quit when prompted."""
+        if self._prompt_mode == "quit_confirm":
+            self._prompt_mode = None
+            self.query_one("#message", MessageBar).clear()
+            self.exit()
+
+    def action_cancel_quit(self) -> None:
+        """Cancel quit when prompted."""
+        if self._prompt_mode == "quit_confirm":
+            self._prompt_mode = None
+            self.query_one("#message", MessageBar).clear()
+            editor = self.query_one("#editor", CommitTextArea)
+            editor.read_only = False
+            editor.focus()
+
+    def on_key(self, event) -> None:
+        """Handle key events for prompts."""
+        if self._prompt_mode == "quit_confirm":
+            if event.key == "y":
+                event.prevent_default()
+                event.stop()
+                self.action_confirm_quit()
+            elif event.key in ("n", "escape"):
+                event.prevent_default()
+                event.stop()
+                self.action_cancel_quit()
+
+    @on(CommitTextArea.Changed)
+    def on_editor_changed(self, event: CommitTextArea.Changed) -> None:
+        """Handle text changes - update dirty state and wrap body lines."""
+        editor = self.query_one("#editor", CommitTextArea)
+        self.dirty = editor.text != self._original_content
+
+        # Auto-wrap body lines
+        editor.wrap_current_body_line()
+
+        # Clear any message when user starts typing
+        if self._prompt_mode is None:
+            self.query_one("#message", MessageBar).clear()
+
+        self._update_status_bar()
+
+    @on(CommitTextArea.SelectionChanged)
+    def on_selection_changed(self, event: CommitTextArea.SelectionChanged) -> None:
+        """Update status bar on cursor movement."""
+        self._update_status_bar()
+
+    def _update_status_bar(self) -> None:
+        """Update the status bar with current state."""
+        editor = self.query_one("#editor", CommitTextArea)
+        status = self.query_one("#status", StatusBar)
+
+        line, col = editor.get_cursor_position()
+        title_length = editor.get_title_length()
+
+        status.update_status(line, col, title_length, self.dirty)
+
+    def _show_message(self, message: str, error: bool = False) -> None:
+        """Show a message in the message bar."""
+        message_bar = self.query_one("#message", MessageBar)
+        message_bar.show_message(message, error=error)
+
+    def action_save(self) -> None:
+        """Save the file."""
+        editor = self.query_one("#editor", CommitTextArea)
+        content = editor.text
+
+        # Strip trailing whitespace from each line and ensure file ends with a newline
+        lines = content.split("\n")
+        content = "\n".join(line.rstrip() for line in lines)
+        if not content.endswith("\n"):
+            content += "\n"
+
+        self.filename.write_text(content)
+        self._original_content = content
+        self.dirty = False
+
+        self._update_status_bar()
+        self._show_message(f"Saved {self.filename}")
+
+    def action_quit_app(self) -> None:
+        """Quit the application, prompting if there are unsaved changes."""
+        if self.dirty:
+            self._prompt_mode = "quit_confirm"
+            # Disable editor to prevent key events from being consumed
+            editor = self.query_one("#editor", CommitTextArea)
+            editor.read_only = True
+            message_bar = self.query_one("#message", MessageBar)
+            message_bar.show_prompt("Unsaved changes. Quit anyway? (y,n,esc)")
+        else:
+            self.exit()
+
+    def action_toggle_signoff(self) -> None:
+        """Toggle the Signed-off-by line."""
+        editor = self.query_one("#editor", CommitTextArea)
+        text = editor.text
+        lines = text.split("\n")
+
+        signoff = get_signed_off_by()
+        if not signoff:
+            self._show_message("Git user not configured", error=True)
+            return
+
+        # Find where git comments start (lines starting with #)
+        comment_start_index = len(lines)
+        for i, line in enumerate(lines):
+            if line.startswith("#"):
+                comment_start_index = i
+                break
+
+        # Split into content and comments
+        content_lines = lines[:comment_start_index]
+        comment_lines = lines[comment_start_index:]
+
+        # Remove trailing empty lines from content for clean processing
+        while content_lines and not content_lines[-1].strip():
+            content_lines.pop()
+
+        # Check if Signed-off-by already exists in content
+        has_signoff = False
+        signoff_index = -1
+
+        for i in range(len(content_lines) - 1, -1, -1):
+            line = content_lines[i]
+            if line.startswith("Signed-off-by:"):
+                has_signoff = True
+                signoff_index = i
+                break
+            elif line.strip() and not line.startswith("#"):
+                # Stop at first non-empty, non-comment, non-signoff line
+                break
+
+        if has_signoff:
+            # Remove the Signed-off-by line
+            del content_lines[signoff_index]
+            # Remove trailing blank lines from content
+            while content_lines and not content_lines[-1].strip():
+                content_lines.pop()
+        else:
+            # Add Signed-off-by with blank line if needed
+            if content_lines and content_lines[-1].strip():
+                content_lines.append("")
+            content_lines.append(signoff)
+
+        # Reassemble: content + blank line (if comments exist) + comments
+        if comment_lines:
+            # Ensure blank line between content and comments
+            new_text = "\n".join(content_lines) + "\n\n" + "\n".join(comment_lines)
+        else:
+            new_text = "\n".join(content_lines)
+        cursor_pos = editor.cursor_location
+
+        editor.load_text(new_text)
+
+        # Restore cursor position if possible
+        new_lines = new_text.split("\n")
+        max_row = len(new_lines) - 1
+        new_row = min(cursor_pos[0], max_row)
+        max_col = len(new_lines[new_row]) if new_row < len(new_lines) else 0
+        new_col = min(cursor_pos[1], max_col)
+        editor.cursor_location = (new_row, new_col)
+
+        self._update_status_bar()

commit_editor-0.1.0/src/commit_editor/cli.py

@@ -0,0 +1,32 @@
+import argparse
+import sys
+from pathlib import Path
+
+
+def main() -> int:
+    """Main entry point for the commit-editor CLI."""
+    parser = argparse.ArgumentParser(
+        prog="commit-editor",
+        description="A terminal-based git commit message editor with opinionated formatting",
+    )
+    parser.add_argument(
+        "filename",
+        type=Path,
+        help="Path to the file to edit",
+    )
+
+    args = parser.parse_args()
+
+    if not args.filename.exists():
+        print(f"Error: File not found: {args.filename}", file=sys.stderr)
+        return 1
+
+    from commit_editor.app import CommitEditorApp
+
+    app = CommitEditorApp(args.filename)
+    app.run()
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

commit_editor-0.1.0/src/commit_editor/git.py

@@ -0,0 +1,40 @@
+import subprocess
+
+
+def get_user_name() -> str | None:
+    try:
+        result = subprocess.run(
+            ["git", "config", "user.name"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        return result.stdout.strip() or None
+    except subprocess.CalledProcessError:
+        return None
+    except FileNotFoundError:
+        return None
+
+
+def get_user_email() -> str | None:
+    try:
+        result = subprocess.run(
+            ["git", "config", "user.email"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        return result.stdout.strip() or None
+    except subprocess.CalledProcessError:
+        return None
+    except FileNotFoundError:
+        return None
+
+
+def get_signed_off_by() -> str | None:
+    name = get_user_name()
+    email = get_user_email()
+
+    if name and email:
+        return f"Signed-off-by: {name} <{email}>"
+    return None