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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyodide-mkdocs-theme
-Version: 5.4.0
+Version: 5.4.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.4.1/pyodide_mkdocs_theme/__version__.py

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

{pyodide_mkdocs_theme-5.4.0 → pyodide_mkdocs_theme-5.4.1}/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.1}/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.1}/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.1}/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.1}/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.1}/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.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyodide-mkdocs-theme"
-version = "5.4.0"
+version = "5.4.1"
 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"