pyodide-mkdocs-theme 5.4.0__tar.gz → 5.4.2__tar.gz

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyodide-mkdocs-theme
-Version: 5.4.0
+Version: 5.4.2
 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.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/PMT_tools/p5/__init__.py

@@ -4,7 +4,7 @@ p5.js wrapper for Pyodide-MkDocs-Theme, by Frédéric Zinelli.
 Basic use:
 
 1. Import p5 as a namespace (no wildcard imports!):
-2. Define the setup and draw callbacks, using calls to the original p6 JS functions,
+2. Define the setup and draw callbacks, using calls to the original p5 JS functions,
    using`p5.functionName()` syntax.
 3. Call `p5.run(setup, draw, preload, target="div_id")` at the end of the code (`preload`
    is optional / `target` is also optional and defaults to the current PMT option value

pyodide_mkdocs_theme-5.4.2/pyodide_mkdocs_theme/__version__.py

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

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/files_extractors/_inclusions_tools.py

@@ -136,7 +136,7 @@ Replacements:{ replacements }"""
         self.err_stack_closing()
         j = self.i
         str_repr = ''.join(self.tokens[i:j])
-        return eval(str_repr)
+        return eval(str_repr)           # Using eval to automatically handle escaped chars
 
 
 INCLUSION_PARSER = InclusionParser()

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/files_extractors/base0_extractors.py

@@ -17,45 +17,42 @@ along with this program.
 If not, see <https://www.gnu.org/licenses/>.
 """
 
+
+
+
 """
 # Extractor general contracts/logic:
 ------------------------------------
 
 
-Represent all the files associated to a runner (IDE, terminal, ...), holding the logic/tools
-to build the various sections contents.
+Represent all the files associated to a runner (IDE, terminal, sqlide, ...), holding the 
+logic/tools to build the various sections contents.
 
 Context/Contracts/Goals:
 
 * An Extractor is linked to a single PMT file, with its potential "direct" dependencies
-(aka REMs, or tests/corr files par for the PM source project's format).
-
-* The PMT file can actually not exist at all! (in that case, exo_py is None)
-
-* A PMT file, if it exists, contains sections, delimited by tokens in the form:
-        `{something} (PMT|PYODIDE):{section} {something}`
-`something` being different depending on what is the file to extract (python, sql, ...).
-.
-* An Extractor instance is cached based on the absolute/resolved path to the main file
-(self.exo_py).
-
-* The cache is automatically refreshed when a local file has been modified (based on the
-stats of the file). NOTE: this update is done at the on_config step, to avoid checking on
-each extractor use/call.
-
-* The contents of the files are stored in the instance, avoiding multiple HDD reads operations.
-
-* Inclusions instructions are gathered after the file content has been read, WITHOUT recursively
-triggering extraction of successors: these will be resolved on demand, when building contents.
-NOTE: this is to allow .snippets.py file containing multiple sections, some of them not being
-used in the "parent" file. These .snippets.py files often using [py] redirections, forcing the
-resolution of the children might cause crashes if some sections of the .snippets.py file would
-require specific content in the parent file while they aren't actually needed for this file.
-
-* The final/actual contents are never stored in the object: sections (inclusions) are rebuilt
-on the fly each time they are needed (relying on the fact reading a file is longer than string
-concatenations, and that the simplification this allows in the implementation compensate for
-the extra computation time).
+(aka REMs, or tests/corr files with the PM source project's setup).
+
+* The PMT file can actually not exist at all! (in that case, exo_file is None)
+
+* A PMT file, if it exists, contains sections delimited by tokens (comments) in the form:
+        
+        {head} (PMT|PYODIDE):{section} {tail}
+        
+  Where `head` and `tail` depend on the type of the file, to build a valide comment (python, sql, ...).
+
+* An Extractor instance is cached based on the absolute/resolved path to the targeted
+ file (aka `self.exo_file`).
+
+* The file is automatically refreshed when a local file has been modified.
+
+* The concrete contents of the files are stored in the instance, avoiding multiple HDD
+reads operations. Note that the content is stored "as is", meaning the inclusions are not 
+resolved yet, but the code is analyzed so that the inclusions are known upfront.
+
+* The final/actual contents are never stored in the object: the concrete contents are 
+always built on the fly/on demand, so that all inclusions redirections can apply where 
+needed.
 """
 # pylint: disable=multiple-statements, missing-function-docstring
 
@@ -121,14 +118,15 @@ class BaseFilesExtractor:
     Path to the master main file (if any).
     Also used as key cache to retrieve an Extractor instance.
 
-    WARNING: This path is absolute AND normalized, while an exo_py for an IDE actually needs the
-             absolute UNnormalized path when generating its html id (for backward compatibility,
-             when checking their uniqueness).
+    WARNING: This path is absolute + resolved, whereas the runner_file for an IDE actually is 
+             absolute but NOT normalized (to reduce the needs of ID arugments in macros calls,
+             when generating the html ids of the resulting elements).
     """
 
     docs_file: Optional[Path] = None
     """
-    Same as self.exo_file, but relative to the CWD (logging and error messages purpose).
+    Same as self.exo_file, but relative to the CWD (logging and error messages purpose / NOTE:
+    also used to identify an inclusion location, when resolving them).
     """
 
     in_pages: Set[str] = field(default_factory=set)

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/files_extractors/base1_contents_extractor.py

@@ -546,8 +546,7 @@ class BasePmtSectionsExtractor(BasePmtSectionsTools):
         Extraction of a bare file, supposedly containing only one section (implicitly / consider
         it's a `code` section).
         """
-        log_exo = self.exo_file and Path(self.exo_file).relative_to(CWD)
-        self.env.outdated_PM_files.append( (log_exo, self.env.file_location()) )
+        self.env.outdated_PM_files.append( (self.docs_file, self.env.file_location()) )
 
         sections_and_contents = (
             (ScriptData.code,     script_content),

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/files_extractors/base2_inclusions.py

@@ -49,13 +49,16 @@ class FileExtractorWithInclusions(BasePmtSectionsExtractor):
     """
     Manage inclusions in the python files, following this kind of syntaxes:
 
+        ## {{ [cwd]py_name:section:section }}
         ## {{ [md]py_name:section:section }}
         ## {{ [py]py_name:section:section }}
         ## {{ py_name:section:section }}
 
-    Relative paths usable:
+    Relative paths are usable:
         ## {{ ../bal/py_name:section }}
-        ## {{ :section }}                      (= "in the current py file")
+
+    If no `py_name` element, extract from the current python file:
+        ## {{ :section }}
 
     Possible to change the file extractor type on the fly by giving the extension file in py_name.
     """

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_manager.py

@@ -528,6 +528,12 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
     Generic html handling (ids, buttons, ...)
     """
 
+    FORCE_PROJECT_ID_IN_HASH: ClassVar[bool] = False
+    """
+    Some kind of IDEs (generated ones: IDE_tester, IDE_playground) have to use the project id,
+    otherwise their html id _will_ always collide between different projects.
+    """
+
     editor_name: str = ''
     """ tail part of most html elements' ids, in the shape of 'editor_{32 bits hexadecimal}' """
 
@@ -546,7 +552,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
 
 
 
-    def generate_id(self):
+    def _build_string_to_be_hashed(self):
         """
         Generate hash part of the html id for the current element, in the form:
 
@@ -612,9 +618,9 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
         page are more than enough.
         - Consistency of the generated ids through time is more important than anything else.
         - The ids are built using:
-            * the page url (relative to site_dir)
+            * the page url (relative to the docs_dir).
             * the macro name (so that the counts for IDEs is not affected by adding other
-            elements earlier in the page).
+            elements earlier in the page -> stability guarantee).
             * a counter specific to the macro name and the page
 
 
@@ -627,7 +633,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
         For IDE elements without associated python file:
 
         - These are more often subject to side effects across different projects, because the
-        html ids are generated using the PAGE URL (relative to the site_dir), concatenated with
+        html ids are generated using the PAGE URL (relative to the docs_dir), concatenated with
         various things that are specific to the page or the macro. So different website with the
         same relative URL _will_ clash in the localStorage. These require the use of a project_id
         value.
@@ -696,7 +702,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
 
         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
@@ -721,7 +727,12 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
             # DO NOT lstrip `to_hash`, to keep implementation consistent for users, even if it
             # looks ugly on the home page (url is ""). Nobody but me can see it anyway... :rolleyes:
 
-        hashed = self.id_to_hash(to_hash)
+        return to_hash
+
+
+    def generate_id(self):
+        to_hash = self._build_string_to_be_hashed()
+        hashed  = self.id_to_hash(to_hash)
         return hashed
 
 

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_term_ide.py

@@ -19,7 +19,7 @@ If not, see <https://www.gnu.org/licenses/>.
 
 
 from abc import ABCMeta
-from typing import Optional
+from typing import ClassVar, Optional
 
 
 from .. import html_builder as Html
@@ -67,6 +67,8 @@ _BTN_MATERIAL_OVERFLOW = admonition_safe_html('''
 
 class CommonGeneratedIde(IdeManager, metaclass=ABCMeta):
 
+    FORCE_PROJECT_ID_IN_HASH: ClassVar[bool] = True
+
     @classmethod
     def get_markdown(cls, use_mermaid:bool):
         raise NotImplementedError()

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_tester.py

@@ -20,17 +20,15 @@ If not, see <https://www.gnu.org/licenses/>.
 
 import json
 from dataclasses import dataclass, field
-import re
 from textwrap import dedent
-from typing import Any, Callable, ClassVar, Dict, Iterator, List, TYPE_CHECKING, NewType, Optional, Tuple, Type
+from typing import Any, ClassVar, Dict, List, TYPE_CHECKING, NewType, Optional, Tuple, Type
 
 
 
 
 
-from ..exceptions import PmtMacrosInvalidArgumentError
 from .. import html_builder as Html
-from ..tools_and_constants import HtmlClass, PageUrl, PmtPyMacrosName, PageInclusion, Prefix, Qcm, ScriptSection, ScriptData
+from ..tools_and_constants import HtmlClass, PageUrl, PmtPyMacrosName, PageInclusion, Prefix, Qcm, ScriptData
 from ..parsing import compress_LZW
 from ..html_dependencies.deps_class import DepKind
 from ..plugin_tools.test_cases import Case
@@ -121,12 +119,12 @@ class IdeTester(CommonGeneratedIde, Ide):
         Build the code generating the IdeTester object. Insert the MERMAID logistic only if
         the `mkdocs.yml` holds the custom fences code configuration.
         """
-        return dedent(f"""
-            # Testing all IDEs in the documentation {'{'} data-search-exclude {'}'}
+        return dedent(f"""\
+        # Testing all IDEs in the documentation {'{'} data-search-exclude {'}'}
 
-            <br>
+        <br>
 
-            {'{{'} IDE_tester(MAX='+', MERMAID={ use_mermaid }, TERM_H=15) {'}}'}
+        {'{{'} IDE_tester(MAX='+', MERMAID={ use_mermaid }, TERM_H=15) {'}}'}
 
         """)
 

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/macros/qcm.py

@@ -19,6 +19,8 @@ If not, see <https://www.gnu.org/licenses/>.
 # pylint: disable=unused-argument
 
 from functools import wraps
+import json
+from pathlib import Path
 from textwrap import dedent
 from typing import Any, Dict, List, Tuple
 
@@ -75,6 +77,7 @@ def multi_qcm(env:MaestroMacros):
         qcm_title:  str = None,
         tag_list_of_qs: str = None,
         DEBUG:      bool = None,
+        DUMP:       bool = None,
         SHOW:       str = None,         # sink (not needed here!)
         ID=None,                        # sink (deprecated)
     ):
@@ -280,6 +283,29 @@ def multi_qcm(env:MaestroMacros):
 
         qcm_close()
 
+        if DUMP:
+            json_data = {
+                'questions': questions,
+                'description': description,
+                'hide': hide,
+                'multi': multi,
+                'shuffle': shuffle,
+                'shuffle_questions': shuffle_questions,
+                'shuffle_items': shuffle_items,
+                'admo_kind': admo_kind,
+                'admo_class': admo_class,
+                'qcm_title': qcm_title,
+                'tag_list_of_qs': tag_list_of_qs,
+                'DEBUG': DEBUG,
+            }
+
+            name = env.page.url.strip('/').split('/')[-1]
+            loc = Path(env.page.file.abs_src_path).with_name(f"qcm_{ name }_{ env.compteur_qcms }.json")
+            content = json.dumps(json_data, indent=2)
+            loc.touch(exist_ok=True)
+            loc.write_text(content, encoding='utf-8')
+
+
 
         output = '\n'.join(admonition_lst)
         output = f'\n\n{ output }\n\n'    # Enforce empty spaces around in the markdown admonition

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/plugin/maestro_base.py

@@ -148,6 +148,7 @@ class BaseMaestro(BasePlugin[PyodideMacrosConfig]):
     args_figure_p5_buttons: str = ConfigExtractor('config.args.figure', prop='p5_buttons')
 
     args_multi_qcm_DEBUG:             bool = ConfigExtractor('config.args.multi_qcm', prop='DEBUG')
+    args_multi_qcm_DUMP:              bool = ConfigExtractor('config.args.multi_qcm', prop='DUMP')
     args_multi_qcm_SHOW:               str = ConfigExtractor('config.args.multi_qcm', prop='SHOW')
     args_multi_qcm_admo_class:         str = ConfigExtractor('config.args.multi_qcm', prop='admo_class')
     args_multi_qcm_admo_kind:          str = ConfigExtractor('config.args.multi_qcm', prop='admo_kind')

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/plugin/maestro_macros.py

@@ -76,7 +76,7 @@ class MaestroMacroManager(MaestroIndent):
     """
 
 
-    compteur_qcms: int = AutoCounter()
+    compteur_qcms: int = 0
     """ Number of qcm or qcs in the docs """
 
     _editors_ids: Set[str]
@@ -102,7 +102,9 @@ class MaestroMacroManager(MaestroIndent):
 
 
     def get_qcm_id(self):
-        return f"{ Prefix.py_mk_qcm_id_ }{ self.compteur_qcms :0>5}"
+        id = f"{ Prefix.py_mk_qcm_id_ }{ self.compteur_qcms :0>5}"
+        self.compteur_qcms += 1
+        return id
 
 
     def is_unique_then_register(self, id_ide:str, no_id_path:str, ID:Optional[str]) -> bool :

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/plugin_config/definitions/macros_configs.py

@@ -1300,6 +1300,13 @@ MULTI_QCM = MultiQcmConfigSrc.with_default_docs(
         """,
         yaml_desc="Display macro related infos in the terminal.",
     ),
+    ConfigOptionSrc(
+        'DUMP', bool, default=False,
+        docs="""
+            Crée un fichier json avec les données du qcm en cours dans le dossier de la page en cours.
+        """,
+        yaml_desc="Dump the MCQ content as json.",
+    ),
 ))
 
 

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/plugin_config/definitions/sub_configs.py

@@ -877,7 +877,7 @@ TESTING_CONFIG = SubConfigSrc(
         extra_docs = f"""
             Définit si la page de tests des IDEs doit être générée et de quelle façon.
             {'{{'}ul_li([
-                "`#!py '{PageInclusion.none}'` (_défaut_) : la page de tests n'est pas générée.",
+                "`#!py '{PageInclusion.none}'` : la page de tests n'est pas générée.",
                 "`#!py '{PageInclusion.serve}'` : la page de tests est générée pendant `mkdocs serve`,
                 et est ajoutée automatiquement à la navigation.",
                 "`#!py '{PageInclusion.site}'` : La page de tests est ajoutée au site construit,

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/pyodide_macros/plugin_tools/macros_data.py

@@ -533,6 +533,7 @@ class MacroArgsDataMulti_qcm(ObjectWithDataGetters):
     tag_list_of_qs: str = DataGetter()
     DEBUG: bool = DataGetter()
     SHOW: str = DataGetter()
+    DUMP: bool = DataGetter()
 
 class MacroDataMulti_qcm(MacroData):
     """ Runtime data object for the multi_qcm macro. """

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/templates/js-libs/functools.js

@@ -1086,18 +1086,24 @@ export function getIdeDataFromStorage(editorId, ide=null){
       code = obj.code ?? ""
     }catch(_){}
 
-    const upToDate = PMT_LOCAL_STORAGE_KEYS_WRITE.every(k=> k in obj)
-    const storage  = upToDate ? obj : freshStore(code, obj, ide)
+    // If the update to 5.4.0 has occured before the `project.id` was filled by the author,
+    // users might have the localStorage updated with a `project: null` entry. This is not to
+    // be considered "up to date", to avoid basillions of warning for the users (1 per IDE!).
+    const pmt_540_ok = (obj.project??null)!==null
+    const upToDate   = PMT_LOCAL_STORAGE_KEYS_WRITE.every(k=> k in obj) && pmt_540_ok
+    const storage    = upToDate ? obj : freshStore(code, obj, ide)
 
     if(ide && !CONFIG.projectNoJsWarning && storage.project !== CONFIG.projectId){
         const msg = [
             CONFIG.lang.storageIdCollision.msg,
             '',
+            `Project id: "${ CONFIG.projectId }"`,
             `Page: ${ document.location }`,
             `py_name: ${ ide.pyName }`,
-            `Project id: "${ CONFIG.projectId }"`,
-            `Collision id: "${ storage.project }"`,
             `(id: ${ editorId })`,
+            '------------------------\nCollision source:',
+            `Project id: "${ storage.project }"`,
+            `py_name: ${ storage.name }`,
         ]
         window.alert(msg.join('\n'))
     }

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyodide_mkdocs_theme/templates/js-per-pages/qcms-qcm.js

@@ -151,7 +151,7 @@ class QCM {
             perennialMathJaxUpdate()
             renderMermaidGraphs()
         }
-        const [good,all] = this.questions.reduce( (track,quest)=>quest._validate(...track), [0,0])
+        const [good,all] = this.questions.reduce( (track,quest)=>quest._validate(this.reveal, ...track), [0,0])
         this.updateCounter(`${good}/${all}`)
         this.locked = true
     }
@@ -266,21 +266,25 @@ class Question {
         }
     }
 
-    _validate(goods, all){
+    _validate(revealed, goods, all){
         const values = Object.values(this.byId)
 
         /*
         // Count per item:
-        goods += values.reduce( (s,o)=>s+(o.checked === o.correct), 0)
-        all += values.length
+        const localGood = values.reduce( (s,o)=>s+(o.checked === o.correct), 0)
+        const localAll  = values.length
 
         /*/
         // Count per question:
-        goods += values.every( o => o.checked === o.correct )
-        all++
+        const localGood = values.every( o => o.checked === o.correct )
+        const localAll  = true
         //*/
 
-        return [goods, all]
+        if(revealed && this.comment && localGood===localAll){
+            this.comment.prop('open', true)
+        }
+
+        return [goods+localGood, all+localAll]
     }
 
     _reveal(){
@@ -312,7 +316,7 @@ class Question {
 
 
     resetAllItems(always=false){
-        if(this.comment) this.comment.detach()
+        if(this.comment) this.comment.detach().prop('open', false)
         Object.entries(this.byId).forEach(([itemId,it])=>{
             if(always || it.checked) this.updateItem(itemId, false)
         })

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyodide-mkdocs-theme"
-version = "5.4.0"
+version = "5.4.2"
 requires-python = ">=3.9, <4.0"
 license = { text = "GPL-3.0-or-later" }
 description = "Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations"

pyodide_mkdocs_theme-5.4.0/pyodide_mkdocs_theme/__version__.py

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