pyodide-mkdocs-theme 5.6.0__tar.gz → 5.6.1__tar.gz

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyodide-mkdocs-theme
-Version: 5.6.0
+Version: 5.6.1
 Summary: Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations
 License: GPL-3.0-or-later
 Keywords: mkdocs,mkdocs-plugin,pyodide,IDE,terminal

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/__main__.py

@@ -50,7 +50,7 @@ parser = ArgumentParser(
              "This program comes with ABSOLUTELY NO WARRANTY."
 )
 parser.add_argument(
-    '-v', '--version', action='version', version=f'pyodide-mkdocs-theme {__version__}'
+    '-v', '--version', action='version', version=f'v{__version__}'
 )
 parser.add_argument(
     '-n', '--new', default="",

pyodide_mkdocs_theme-5.6.1/pyodide_mkdocs_theme/__version__.py

@@ -0,0 +1 @@
+__version__ = "5.6.1"

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/pyodide_macros/files_extractors/base0_extractors.py

@@ -130,11 +130,6 @@ class BaseFilesExtractor:
     also used to identify an inclusion location, when resolving them).
     """
 
-    in_pages: Set[str] = field(default_factory=set)
-    """
-    Set of pages uri (relative to the docs_dir) that use the current extractor.
-    """
-
     # ---------------------------------------------------------------------------------
 
     ARG_NAME: ClassVar[str] = None
@@ -145,13 +140,9 @@ class BaseFilesExtractor:
 
 
     def __post_init__(self):
-
         if self.runner_file:
             self.exo_file  = Path(self.runner_file).resolve()
             self.docs_file = Path(self.exo_file).relative_to(CWD)
-            md_uri = self.env.page.file.src_uri
-            self.in_pages.add(md_uri)
-
 
     def __hash__(self):
         return hash(self.exo_file)
@@ -258,6 +249,12 @@ class BaseExtractorWithCache(BaseFilesExtractor):
     _mtime_infos: Dict[Path, Optional[int]] = None
 
 
+    in_pages: Set[str] = field(default_factory=set)
+    """
+    Set of pages uri (relative to the docs_dir) that use the current extractor (used for external
+    purposes only, aka, mkdocs-addresses)
+    """
+
 
     @classmethod
     def _get_file_extractor_for(
@@ -287,6 +284,8 @@ class BaseExtractorWithCache(BaseFilesExtractor):
         elif not extractor.is_up_to_date():
             extractor.extract_contents()
 
+        md_uri = env.page.file.src_uri
+        extractor.in_pages.add(md_uri)
         return runner_file, extractor
 
 

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/pyodide_macros/html_dependencies/deps_class.py

@@ -76,7 +76,7 @@ class DepKind:
         sorting from the given @kind, which is already present in @needs.
         Keep adding kinds as long as they are not present in @needs.
         """
-        # NOTE: this is almost useless, for PMT 4^ because of automatic resolution of imported
+        # NOTE: this is almost useless for PMT 4+, because of automatic resolution of imported
         # modules, BUT there are still some needs for non modules, so keep everything as is...
 
         # Keep in mind DepKind _values_ are actually SIMPLE STRINGS!
@@ -159,10 +159,10 @@ class Dep:
     """ Static property: Store HtmlDependencies property names, to make sure they are unique. """
 
 
-
     def __init_subclass__(cls):
         Dep.EXTENSION_TO_CLASS[cls.EXTENSION] = cls
 
+    #-------------------------------------------------------------------------
 
     @staticmethod
     def auto_ordering():
@@ -218,11 +218,18 @@ class Dep:
 
 
     def get_html_tag(self):
+        """
+        Convert tu current dependency to the corresponding html tag to insert in the page.
+        """
         return self.DUMP_TEMPLATE.format(
             data=' '.join(f'{k}="{v}"' for k,v in self.data.items())
         )
 
     def gen_import_map(self):
+        """
+        Return an iterator of items to add the current dependency to the importmap tag.
+        Reminder: only js modules have to be referenced.
+        """
         return ()
 
 

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_manager.py

@@ -21,6 +21,7 @@ If not, see <https://www.gnu.org/licenses/>.
 
 
 from abc import ABCMeta
+import os
 import re
 import hashlib
 from typing import Any, ClassVar, Dict, List, Literal, Optional, Tuple, Union, TYPE_CHECKING
@@ -706,31 +707,35 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
             local machine.
         """
         is_ide      = PmtPyMacrosName.is_ide(self.MACRO_NAME)
-        is_relative = not self.env.is_legacy
+        not_legacy  = not self.env.is_legacy
         runner_path = self.exo_py
         has_py_file = bool(runner_path)
-        project_id  = self.env.project_id or ""
 
-        need_project_id = is_ide and self.env.project_disambiguate_local_storage and project_id and (
-            not has_py_file or is_relative
-        ) or self.FORCE_PROJECT_ID_IN_HASH
-        # The project_id is needed to disambiguate the html ids in the localStorage only if:
-        #   1. The element is an IDE
-        #   2. The user actually gave a value for env.project_id
-        #   3. The user _wants_ the project_id added to compute the html ids
-        #   4. Either...:
-        #       - the ides_id_hash_mode is set to relative
-        #       - Or there is no python file for the IDE
-
-        project_id = f':_{ project_id }' * bool(need_project_id)
+        need_project_id = bool(self.FORCE_PROJECT_ID_IN_HASH or (
+            is_ide
+            and self.env.project_disambiguate_local_storage
+            and self.env.project_id
+            and (not_legacy or not has_py_file )
+        ))
+        project_id = f':_{ self.env.project_id or "" }' * need_project_id
 
         if has_py_file and (is_ide or self.env.ACTIVATE_CACHE):
 
             less_ID_needs = "" if is_ide else ':'+self.MACRO_NAME
-            if is_ide and is_relative:
+            if is_ide and not_legacy:
                 runner_path = Path(self.exo_py).relative_to(self.env.docs_dir_path)
 
+            if os.getenv("IDE_ID_WITH_POSIX"):
+                runner_path = runner_path.as_posix()
+                # This is used in CodEx's tests, to make sure the ids do not depend on the OS.
+                # Without that, the IDE ids do not match the ones registered in Capytale.
+
             to_hash = f"{ runner_path }{ self.IDE_VERT }{ less_ID_needs }{ project_id }"
+            # WARNING: there is still a problem here depending on the OS: people working
+            # on win/something else will get different html ids because of `\` vs `/` in
+            # `runner_path`... This is not a problem, from the end users PoV. This is only
+            # a problem (so far) for CodEx tests on Capytale, because the server stores the
+            # html ids of the DIE, to know where to put what.
 
         else:
             count   = self.env.macros_counters[ self.MACRO_NAME ].inc()

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/pyodide_macros/macros/py_script.py

@@ -46,7 +46,7 @@ def _more_code_fence(
     title: str,
     attrs: str,
     no_block: bool,
-    lang: str='python',
+    lang: str=None,
 ):
     """
     Extra function to centralize some of the formatting logic.
@@ -61,7 +61,7 @@ def _more_code_fence(
         indent,
         title=(title or ""),
         attrs=(attrs or ""),
-        lang=lang,
+        lang=lang or 'python',
     )
     return out
 

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/pyodide_macros/plugin_tools/pages_and_macros_py_configs.py

@@ -207,7 +207,12 @@ class PageConfiguration(Dict[EditorName,MacroPyConfig]):
     def build_page_script_tag_with_ides_configs_mermaid_and_pool_data(
         self, overlord_classes:List[str]
     ):
-
+        """
+        Build a synch script tag, that his adding to the page the global data structures so that
+        the various elements needed in the page can be built:
+        - Update CONFIG mermaid and classes pool infos
+        - build the PAGE_IDES_CONFIGS compressed string
+        """
         json_ide_configs = '{' + ', '.join(
             f'"{ editor_name }": { ide_conf.dump_to_js_code() }'
             for editor_name, ide_conf in self.items()

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/pyodide_macros/plugin_tools/test_cases.py

@@ -20,7 +20,7 @@ If not, see <https://www.gnu.org/licenses/>.
 
 
 
-from typing import ClassVar, Dict, List, Literal, Optional, Set, Tuple, Union, TYPE_CHECKING
+from typing import ClassVar, Dict, List, Literal, Optional, Sequence, Set, Tuple, Union, TYPE_CHECKING
 from dataclasses import dataclass, field, fields
 
 from pyodide_mkdocs_theme.pyodide_macros.tools_and_constants import IdeMode, NamedTestCase
@@ -126,6 +126,13 @@ class Case:
     """
     Don't clear the scope before doing this test (NOTE: this would become useless if the tests
     were not run in order).
+    When this feature is used, the `input` fonction will be overridden on the fly in the global
+    scope, before the code to test is run. The new function is returning the values in order, one
+    element per call. If all inputs are consumed, the call is transferred to the original builtin.
+    This custom function is removed from the environment after the test.
+
+    If the code of the tests also replace/define a custom `input` function, there is no guarantee
+    about what will happen.
     """
 
     term_cmd: Optional[str] = None
@@ -138,7 +145,6 @@ class Case:
     Quick description of the test (optional).
     """
 
-
     #-------------------------------------------------------------------------
     # Private interface:
 
@@ -508,9 +514,12 @@ Case.CORR     = Case()                  # Default case before PMT 5.0
 Case.HUMAN    = Case(human=True)
 Case.NO_CLEAR = Case(no_clear=True)
 
-Case.DEFAULT = Case(no_clear=False, description="", subcases=[
-    Case(description="corr vs validation (succès)"),
-    Case(description="code vs validation (échec)", code=True, fail=True),
+
+
+# Enforce no_clear directly on subcases because these might be copied in auto_convert_and_fix_case:
+Case.DEFAULT = Case(description="", subcases=[
+    Case(description="corr vs validation (succès)", no_clear=False),
+    Case(description="code vs validation (échec)", no_clear=False, code=True, fail=True),
     # Case(description="`code` vs `tests` (échec)", code=True, fail=True, run_play=True),
 ])
 

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/templates/README.md

@@ -56,3 +56,39 @@ All js scripts are systematically present on the server/built site, but their in
 
 
 1. `templates/js-scripts` scripts are finally run. They are __always present__, and added in as a last step of the Jinja `scripts` block.
+
+
+
+
+
+
+## Files hierarchy and naming "conventions"...
+
+This looks like a total mess, I know... The naming is actually constrained for various reasons, some due to legacy behaviors, others are just about easing the navigation in the code during development...
+
+The three folders are required by the implementation. They are m
+
+| Directory | Inserted in `main.html` in... |
+|-|-|
+| js-libs      | the libs block |
+| js-per-pages | the content block |
+| js-scripts   | the scripts block |
+
+The order of the files in each directory matters for scripts that are loaded synch:
+
+- js-libs/0-config.js
+- js-libs/0-legacy-subscriber.js
+- js-libs/mathjax-libs.js
+
+/!\ WARNING /!\
+---------------
+
+The name of the mathjax CANNOT BE CHANGED for backward compatibility reasons (users may have overridden it through the custom_dir)
+
+In the `js-per-pages` directory, the numbers are here only to ease development: they more or less follow the dependency orders.
+Why no subdirectories? ...because I didn't want more depth during development. These folders are used so often that I didn't want to have one more click to do to reach the file I needed...
+
+The files in `js-per-pages` also are in the form `N-something-suffix.js`, where `suffix` is used so that the devops tool building the dependencies knows what file is used for what purpose, when building the dependencies in the python layer.
+This is done this way to keep most of the JS logic/configuration in the JS layer, the python one implementing only the logic and having almost no configuration data (aside of the directories locations) to rebuild everything correctly even after some changes occurred on the JS side.
+
+So, yeah. That's dirty, but that works pretty well, in the end, and avoids a lot of time lost for nothing.

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/templates/js-libs/0-legacy-subscriber.js

@@ -24,17 +24,17 @@ const jsLogger =()=> null
 //*
 globalThis.LOGGER_CONFIG = {}
 /*/
-globalThis.LOGGER_CONFIG = {ACTIVATE:true, all:1}
+globalThis.LOGGER_CONFIG = {ACTIVATE:1, all:1}
 //*/
 
 
 
-/**Defined for backward compatibility, incase the user is still using the function from the
- * original synch implementation of subscribeWhenReady.
+/**Defined for backward compatibility, in case the user is still relying on the function from
+ * the original synch implementation of subscribeWhenReady.
  *
  * Facts:
- *  1. MathJax subscription is now done from the js-scripts/subscriptions.js module, so any
- *     call for mathjax coming from a user override is totally useless and can just be skipped.
+ *  1. MathJax subscription is now done from the `js-scripts/subscriptions.js` module, so any
+ *     call for mathjax coming from a user override is totally useless and can just be ignored.
  *  2. If ever another subscription is done, just directly transmit the call to the module
  *     version, to unify the implementations/logics.
  * */
@@ -52,6 +52,5 @@ function subscribeWhenReady(subscriptionId, ...args){
             module.subscribeWhenReady(subscriptionId, ...args)
         })
     }
-
-    return ()=>0        // SINK! (the default mathjax override _will_ call a fonction)
+    return ()=>null   // SINK! (the default mathjax override _will_ call a fonction)
 }

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/templates/js-per-pages/0-generic-python-snippets-pyodide.js

@@ -243,6 +243,9 @@ def _hack_auto_run():
 
     # Keep uncleaned elements:
     runner = AutoRunner()
+
+    # Since this snippet will be run for each new section, always transfer existing traced
+    # calls to the new object:
     if hasattr(__builtins__, 'auto_run'):
         runner.run |= __builtins__.auto_run.run
     __builtins__.auto_run = runner
@@ -531,24 +534,10 @@ def _hack_scope_cleaner():
     clearScope: `clear_scope()`,
 
 
-    wantedImports: `
-@auto_run
-def _hack_find_imports():
-    from pyodide.code import find_imports
-    __builtins__.imported_modules = find_imports({FORMAT_TOKEN})
-
-__builtins__.imported_modules
-`,
-
+    wantedImports: `__import__('pyodide').code.find_imports({FORMAT_TOKEN})`,
 
-    alreadyImported: `
-@auto_run
-def _hack_imported():
-    import sys
-    __builtins__.loaded_modules = " ".join(sys.modules.keys())
 
-__builtins__.loaded_modules
-`,
+    alreadyImported: `" ".join(__import__('sys').modules.keys())`,
 
 
     upDownLoader: `
@@ -910,6 +899,16 @@ def _hack_mermaid():
 def _hack_stdout_up():
     import sys, io, js
 
+    # Keep a StringIO object there (this also allows to enforce a flush of the stdout content
+    # in between runs/sections, on user's side, and redactors wanting to test against the user
+    # stdout will also use this:
+    __builtins__.src_stdout = sys.stdout
+    sys.stdout = io.StringIO()
+
+    # Different object allowing to spot what to print exactly, for one single call to print:
+    __builtins__.per_call_std_out = io.StringIO()
+
+
     @wraps_builtin
     def print(*a,**kw):     # Note: wraps doesn't seem to work... Dunno why...)
 
@@ -917,45 +916,29 @@ def _hack_stdout_up():
         __print_src__(*a,**kw)
 
         # Then print to the one used to get proper formatting (according to the generic
-        # behavior of python print function), then extract the formatted content to
-        # transfer to the terminal and empty per_call_stdout:
-
-        kw['file'] = per_call_stdout
-        __print_src__(*a,**kw)
-        properly_formatted = per_call_stdout.getvalue()
-        per_call_stdout.truncate(0)
-        per_call_stdout.seek(0)
-
+        # behavior of python print function):
+        kw['file'] = per_call_std_out
+        __print_src__(*a, **kw)
+
+        # Then extract the formatted content to write to the terminal and empty per_call_std_out:
+        properly_formatted = per_call_std_out.getvalue()
+        per_call_std_out.truncate(0)
+        per_call_std_out.seek(0)
         js.config().termMessage(None, properly_formatted, 'none', True)
-
-
-    # Different object allowing to spot what to print exactly, for one single call to print:
-    __builtins__.per_call_std_out = per_call_stdout = io.StringIO()
-
-    # Keep a StringIO object there (this also allows to enforce a flush of the stdout content
-    # in between runs/sections, on user's side, and redactors wanting to test against the user
-    # stdout will also use this:
-    __builtins__.src_stdout = sys.stdout
-    sys.stdout = io.StringIO()
 `,
 
 
-    getFullStdIO:`
+    teardownStdIO:`
 @__builtins__.auto_run
 def _hack_stdout_down():
     import sys
 
-    # Store to send the result to JS layer at the end:
-    __builtins__._stdout_value = sys.stdout.getvalue()
-
     sys.stdout.close()
     sys.stdout = __builtins__.src_stdout
     del __builtins__.src_stdout
 
     __builtins__.per_call_std_out.close()
     __builtins__.print = __builtins__.__print_src__
-
-__builtins__._stdout_value
 `,
     }
 
@@ -1050,9 +1033,8 @@ export const setupStdIO =_=>{       // WARNING: some arguments may be passed in
     pyodideFeatureRunCode('setupStdIO')
 }
 
-export const getFullStdIO =_=>{
-    const stdout = pyodideFeatureRunCode('getFullStdIO') || ''
-    return escapeSquareBrackets(stdout)
+export const teardownStdIO =_=>{
+    pyodideFeatureRunCode('teardownStdIO')
 }
 
 export const clearPyodideScope=()=>{

{pyodide_mkdocs_theme-5.6.0 → pyodide_mkdocs_theme-5.6.1}/pyodide_mkdocs_theme/templates/js-per-pages/1-runtimeManager-runtime-pyodide.js

@@ -25,7 +25,7 @@ import {
   youAreInTroubles,
 } from 'functoolsTxt'
 import {
-  getFullStdIO,
+  teardownStdIO,
   pyodideFeatureRunCode,
   setupStdIO,
 } from '0-generic-python-snippets-pyodide'
@@ -363,7 +363,7 @@ export class RuntimeManager {
 
 
   async teardownManager(ctx){
-    getFullStdIO()
+    teardownStdIO()
 
     if(!ctx.err) return;    // nothing to do if no error during the current run.