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

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

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

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

{pyodide_mkdocs_theme-5.4.2 → pyodide_mkdocs_theme-5.4.4}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_playground.py

@@ -65,6 +65,14 @@ class IdePlayground(CommonGeneratedIde, Ide):
 
 
 
+    def exported_items(self):
+        yield from (
+            (k,v) if k!='deactivate_stdout_for_secrets' else (k, False)
+            for k,v in super().exported_items()
+        )
+
+
+
     def register_ide_for_tests(self):
         """ IdeTester instances are never registered for testing... """
 
@@ -111,11 +119,12 @@ class IdePlayground(CommonGeneratedIde, Ide):
 
 Cette page permet de développer dynamiquement dans un contexte où les différentes sections sont modifiables et exécutables à volonté : lorsque l'IDE est exécuté, les contenus de tous les autres éditeurs de la page sont utilisés en tant que sections de l'IDE.
 
+* Les raccourcis ++ctrl+s++ (tests publics) et ++ctrl+enter++ (validation) sont actifs dans n'importe quel éditeur de la page.
+* Le bouton de téléversement permet d'importer un fichier existant pour ensuite en modifier les différentes sections.
+* Le bouton de téléchargement sous l'IDE permet de récupérer un fichier PMT correctement formaté, avec toutes les sections assemblées.
 * Le contenu de la section `tests` est automatiquement exécuté après le contenu de l'IDE : il n'est pas nécessaire d'en rajouter le code dans celui-ci pour retrouver le comportement habituel des IDEs normaux, que ce soit pour les tests publics ou les validations.
 * Mermaid est utilisable dans cette page, ainsi que les autres outils complémentaires (p5, matplotlib, ...).
-* Le bouton de téléchargement sous l'IDE permet de récupérer un fichier PMT correctement formaté, avec toutes les sections assemblées.
-* Le bouton de téléversement permet d'importer un fichier existant pour ensuite en modifier les différentes sections.
-* Les raccourcis ++ctrl+s++ et ++ctrl+enter++ sont actifs depuis n'importe quel éditeur dans la page.
+* Dans la apge Plyagournd, la sortie standard est toujours visible durant les validations, de manière à ne pas rencontrer d'erreurs si le code des tests secrets utilise `terminal_message`.
 
 <br>
 

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

@@ -299,11 +299,18 @@ def multi_qcm(env:MaestroMacros):
                 '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")
+            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')
+            update  = True
+            if loc.is_file():
+                current = loc.read_text(encoding='utf-8')
+                update = current != content
+                # Update the file only if the content is different, to avaoid infinite serve loops...
+            else:
+                loc.touch(exist_ok=True)
+            if update:
+                loc.write_text(content, encoding='utf-8')
 
 
 

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

@@ -434,10 +434,6 @@ class MaestroMacros(MaestroMacroManager):
         search plugin starts indexing stuff in the related plugin (which precisely happens
         in the on_page_context hook).
         """
-        # pylint: disable=pointless-string-statement
-
-        # Log AFTER the call to `get_page_config_and_set_base_url`, because self.file_location
-        # needs the current page object:
         logger.debug(f"Add scripts + encrypt solutions and remarks in {self.file_location()}")
 
         chunks       = []

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

@@ -657,9 +657,9 @@ IDE = MacroConfigSrc(
             deactivated.
         """,
         docs = """
-            Clef à passer en argument de [`terminal_message`](--IDEs-terminal_message) pour
-            autoriser son utilisation lorsque la sortie standard est désactivée pendant les
-            tests.
+            Clef à passer en argument de [`terminal_message`](--IDEs-terminal_message)
+            pour autoriser son utilisation lorsque [la sortie standard est
+            désactivée](--pyodide_macros_ides_deactivate_stdout_for_secrets) pendant les tests.
         """,
         extra_docs='--8<-- "docs_tools/inclusions/IDE_STD_KEY_validation.md"',
     ),
@@ -1303,9 +1303,10 @@ MULTI_QCM = MultiQcmConfigSrc.with_default_docs(
     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.
+            Crée un fichier json avec les données du qcm en cours dans le dossier de la page en cours.{{
+            pmt_note("Utilisable uniquement en local.")}}
         """,
-        yaml_desc="Dump the MCQ content as json.",
+        yaml_desc="Dump the MCQ content as json (local use only).",
     ),
 ))
 

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

@@ -424,6 +424,10 @@ IDES_CONFIG = SubConfigSrc(
         extra_docs="""
             Détermine si la sortie standard (stdout) sera visible dans les terminaux lors
             des tests secrets ou non.
+
+            Si la sortie standard est désactivée, il est impossible d'utiliser la fonction
+            `terminal_message` durant les tests secrets sans passer en premier argument la
+            valeur correspondant à l'argument [`STD_KEY`](--IDE-STD_KEY) de l'IDE concerné.
         """,
         yaml_desc="""
             Define if the stdout will be shown in terminals to the user or not, during the

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

@@ -1031,12 +1031,39 @@ export const noStorage = function () {
 
 
 
-
+/**Extract all the cmd histories and the IDEs data from the localStorage.
+ *
+ * There is a dirty bug somewhere (unknown for now), where the bare code string can be stored in
+ * a localStorage entry instead of the usual object. Just spot those entries and remove them.
+ * Also warn the user and ask for raising an issue on the repo...
+ */
 export const getStorageEntries=()=>{
+
+    const somethingWrong = []
     const data  = Object.entries(localStorage)
     const cmds  = data.filter( ([id,_]) => /^\d+_commands$/.test(id) )
     const ides  = data.filter( ([id,_])=>/^editor_[\da-f]{16,}$/.test(id) )
-                      .map( ([k,o])=>[k,JSON.parse(o)] )
+                      .map( ([k,s])=>{
+                        try{
+                            return [k,JSON.parse(s)]
+                        }catch(_){
+                            somethingWrong.push([k,s])
+                            localStorage.removeItem(k)
+                        }
+                    })
+
+    if(somethingWrong.length){
+        const msg = `
+Some invalid data have been found in the localStorage.
+Please contact the author of Pyodide-MkDocs-Theme, opening an issue on the repository with the data you may find in the console of your browser (F12).
+
+Repository:
+  ${ CONFIG.pmtUrl }
+`
+        console.error('\nInformation to give on the PMT repository:\n')
+        console.log(somethingWrong.map(([k,s])=>'\n---\n  '+k+':\n'+s).join('\n'))
+        window.alert(msg)
+    }
     return {cmds, ides}
 }
 
@@ -1086,9 +1113,9 @@ export function getIdeDataFromStorage(editorId, ide=null){
       code = obj.code ?? ""
     }catch(_){}
 
-    // If the update to 5.4.0 has occured before the `project.id` was filled by the author,
+    // If the update to 5.4.0 has occurred 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!).
+    // be considered "up to date", to avoid bazillions 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)

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

@@ -1,6 +1,6 @@
 [project]
 name = "pyodide-mkdocs-theme"
-version = "5.4.2"
+version = "5.4.4"
 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.2/pyodide_mkdocs_theme/__version__.py

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