Support overriding edit_uri on a File

Author: oprypin

mkdocs/structure/files.py

@@ -247,6 +247,10 @@ def __repr__(self):
             f"dest_uri={self.dest_uri!r}, inclusion={self.inclusion})"
         )
 
+    @utils.weak_property
+    def edit_uri(self) -> str | None:
+        return self.src_uri if self.generated_by is None else None
+
     def _get_stem(self) -> str:
         """Soft-deprecated, do not use."""
         filename = posixpath.basename(self.src_uri)

mkdocs/structure/pages.py

@@ -176,28 +176,33 @@ def _set_edit_url(
         if not edit_uri_template and not edit_uri:
             self.edit_url = None
             return
-        src_uri = self.file.src_uri
+        src_uri = self.file.edit_uri
+        if src_uri is None:
+            self.edit_url = None
+            return
+
         if edit_uri_template:
             noext = posixpath.splitext(src_uri)[0]
-            edit_uri = edit_uri_template.format(path=src_uri, path_noext=noext)
+            file_edit_uri = edit_uri_template.format(path=src_uri, path_noext=noext)
         else:
             assert edit_uri is not None and edit_uri.endswith('/')
-            edit_uri += src_uri
+            file_edit_uri = edit_uri + src_uri
+
         if repo_url:
             # Ensure urljoin behavior is correct
-            if not edit_uri.startswith(('?', '#')) and not repo_url.endswith('/'):
+            if not file_edit_uri.startswith(('?', '#')) and not repo_url.endswith('/'):
                 repo_url += '/'
         else:
             try:
-                parsed_url = urlsplit(edit_uri)
+                parsed_url = urlsplit(file_edit_uri)
                 if not parsed_url.scheme or not parsed_url.netloc:
                     log.warning(
-                        f"edit_uri: {edit_uri!r} is not a valid URL, it should include the http:// (scheme)"
+                        f"edit_uri: {file_edit_uri!r} is not a valid URL, it should include the http:// (scheme)"
                     )
             except ValueError as e:
-                log.warning(f"edit_uri: {edit_uri!r} is not a valid URL: {e}")
+                log.warning(f"edit_uri: {file_edit_uri!r} is not a valid URL: {e}")
 
-        self.edit_url = urljoin(repo_url or '', edit_uri)
+        self.edit_url = urljoin(repo_url or '', file_edit_uri)
 
     def read_source(self, config: MkDocsConfig) -> None:
         source = config.plugins.on_page_read_source(page=self, config=config)

mkdocs/tests/structure/page_tests.py

@@ -677,6 +677,26 @@ def test_page_edit_url_warning(self):
                 self.assertEqual(pg.edit_url, case['edit_url'])
                 self.assertEqual(cm.output, [case['warning']])
 
+    def test_page_edit_url_custom_from_file(self):
+        for case in [
+            dict(
+                edit_uri='hooks.py',
+                expected_edit_url='https://github.com/mkdocs/mkdocs/edit/master/docs/hooks.py',
+            ),
+            dict(
+                edit_uri='../scripts/hooks.py',
+                expected_edit_url='https://github.com/mkdocs/mkdocs/edit/master/scripts/hooks.py',
+            ),
+            dict(edit_uri=None, expected_edit_url=None),
+        ]:
+            with self.subTest(case['edit_uri']):
+                cfg = load_config(repo_url='https://github.com/mkdocs/mkdocs')
+                fl = File('testing.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)
+                fl.edit_uri = case['edit_uri']
+                pg = Page('Foo', fl, cfg)
+                self.assertEqual(pg.url, 'testing/')
+                self.assertEqual(pg.edit_url, case['expected_edit_url'])
+
     def test_page_render(self):
         cfg = load_config()
         fl = File('testing.md', cfg.docs_dir, cfg.site_dir, cfg.use_directory_urls)