pyodide-mkdocs-theme 5.4.3__tar.gz → 5.4.5__tar.gz

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/PKG-INFO

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

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

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_ide.py

@@ -577,26 +577,26 @@ class Ide(CommonTermIde):
         Build a list of all the buttons to add after the IDE.
         """
         buttons = [
-            self.create_button("play"),
-            self.create_button("check") if self.has_check_btn else "",
-            self.create_button("download", margin_left=1 ),
-            self.create_button("upload", margin_right=1 ),
-            self.create_button("restart"),
-            self.create_button("save"),
+            self.create_button("play", bare_tip=True),
+            self.create_button("check", bare_tip=True) if self.has_check_btn else "",
+            self.create_button("download", bare_tip=True, margin_left=1 ),
+            self.create_button("upload", bare_tip=True, margin_right=1 ),
+            self.create_button("restart", bare_tip=True),
+            self.create_button("save", bare_tip=True),
         ]
 
         if self.export:
             buttons.append(
-                self.create_button("zip")
+                self.create_button("zip", bare_tip=True)
             )
         if self.has_corr_btn:           # "mkdocs serve" only:
             buttons.append(
-                self.create_button("corr_btn", margin_left=1)
+                self.create_button("corr_btn", bare_tip=True, margin_left=1)
             )
         if self.has_reveal_btn:         # "mkdocs serve" only:
             margin_left = {} if self.has_corr_btn else {"margin_left": 1}
             buttons.append(
-                self.create_button("show", **margin_left),
+                self.create_button("show", bare_tip=True, **margin_left),
             )
 
         return buttons

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_manager.py

@@ -777,6 +777,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
         margin_right:  float = 0.2,
         extra_btn_kls: str   = "",
         tip_side:       P5BtnLocation = "",
+        bare_tip:       bool = False,
         **kwargs
     ) -> str:
         """
@@ -794,6 +795,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
             margin_right  = margin_right,
             extra_btn_kls = extra_btn_kls,
             tip_side      = tip_side,
+            bare_tip      = bare_tip,
             **kwargs
         )
 
@@ -834,7 +836,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
         if bare_tip:
             tip_span = ""
             kwargs['data'] = kwargs.get('data', {})
-            kwargs['data']['tip-txt'] = tip_txt
+            kwargs['data']['tip-txt'] = str(tip_txt)
             if tip_txt.em: kwargs['data']['tip-width'] = tip_txt.em
         else:
             tip_span = Html.tooltip(tip_txt, tip_txt.em, tip_side=tip_side or P5BtnLocation.bottom)

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/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... """
 
@@ -106,16 +114,18 @@ class IdePlayground(CommonGeneratedIde, Ide):
         """
 
         return f"""
-# Playground  {'{'} data-search-exclude {'}'}
+# Playground  {{ data-search-exclude }}
 
 
 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 page Playground, 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`.
+* L'id html de la figure a la valeur par défaut pour une page localisée directement dans le `docs_dir`.
 
 <br>
 

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/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.3 → pyodide_mkdocs_theme-5.4.5}/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.3 → pyodide_mkdocs_theme-5.4.5}/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.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/pyodide_macros/plugin_tools/test_cases.py

@@ -211,6 +211,11 @@ class Case:
     previously revealed stuff. Use 1000 to get infinite number of attempts.
     """
 
+    done: Optional[int] = None
+    """
+    Value to use for this.storage.done at the beginning of this test.
+    """
+
     show_only_assertion_errors_for_secrets: Optional[bool] = None
     """ Override the current value for the source page, if given. """
 

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/js-per-pages/2-pyodideSectionsRunner-runner-pyodide.js

@@ -277,6 +277,7 @@ class PyodideSectionsRunnerBase {
       LOGGER_CONFIG.ACTIVATE && jsLogger(loggerName)
 
       CONFIG.calledMermaid = false
+      const wasDirty = this.isDirty
       this.makeDirty(false)       // Assume executions will go well (see note in finally block)
       this.running = runningMan
       let runtime
@@ -307,10 +308,16 @@ class PyodideSectionsRunnerBase {
         // For isDirty update, DO NOT only rely on `this.isDirty = runtime.stopped`, so that the
         // runner itself can set the value on a success if needed, and it won't be overridden here
         // (useful if a valid "play" is still considered dirty when a validation exists...).
-        if(!runtime || runtime.stopped){
+        if(!runtime || runtime.stopped || runningMan.isPlaying && wasDirty){
           this.makeDirty()
         }
 
+        // AFTER updating isDirty, remove the validation button border if the current execution
+        // is a validation:
+        if(runningMan.isValidating){
+          this._getJValidationButton().removeClass("dirty-validation")
+        }
+
         if(runtime){
           await finallyTeardown.call(this, runtime)
         }
@@ -544,7 +551,7 @@ class PyodideSequentialRunner extends PyodideSectionsRunnerBase {
     super(id)
 
     this.rotateTerminalMessage = true
-    this.isDirty = true         // Tell if the last run wa successful or not, or if the content has been modified
+    this.isDirty = true         // Tell if the last run was successful or not, or if the content has been modified
                                 // without being run (handled unconditionally for all elements, even if they aren't
                                 // "in sequential run". The RUNNERS_MANAGER handles what is actually to be run or not).
   }

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/js-per-pages/4-ideLogistic-ide.js

@@ -780,6 +780,7 @@ class IdeFullScreenManager extends IdeFullScreenGlobalManager {
 
     this.storeInitPositionsDataIfNeeded()
     const focused = document.activeElement
+    const floatingTip = $("#floating-tip").detach()
 
     this.global[0].requestFullscreen().then(async _=>{
       LOGGER_CONFIG.ACTIVATE && jsLogger('[ScreenMode]', "Full screen ready")
@@ -791,6 +792,8 @@ class IdeFullScreenManager extends IdeFullScreenGlobalManager {
       this.guiIdeFlags.internalIsFullScreen = true
       splitScreenBtn.addClass('deactivated')
       this.ideScreenModeVerticalResize({goingFullScreen: true})
+      this.global.append(floatingTip)
+
       focused.focus()   // Always give back the focus to the element which had it before.
 
       LOGGER_CONFIG.ACTIVATE && jsLogger('[ScreenMode]', "Full screen setup - DONE")
@@ -806,6 +809,7 @@ class IdeFullScreenManager extends IdeFullScreenGlobalManager {
         '[ScreenMode]', "Full screen reversion with", minLines, maxLines
       )
 
+      floatingTip.detach().appendTo('body')
       if(this.splitScreenActivated) splitScreenBtn.removeClass('deactivated')
       this.guiIdeFlags.internalIsFullScreen = false
       const resizeOption = this.isInSplit ? {topDivH:this.setupTopDivHeight()}

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/js-per-pages/4-ideRunner-ide.js

@@ -177,7 +177,7 @@ class IdeHistoryManager extends IdeAceManager {
    * */
   updateValidationBtnColor(done=undefined, jElt=undefined){
     done ??= this.storage.done
-    jElt ??= this.global.find("button[btn_kind=check]")
+    jElt ??= this._getJValidationButton()
     if(!this.isDelayedRevelation){
       const color = this.getIdeStateColor(done)
       jElt.css('--ide-btn-color',  color)
@@ -185,6 +185,10 @@ class IdeHistoryManager extends IdeAceManager {
     return jElt
   }
 
+  _getJValidationButton(){
+    return this.global.find("button[btn_kind=check]")
+  }
+
 
   getIdeStateColor(done){     // CodCap
     return !done ? "unset" : done<0 ? 'red' : 'green'
@@ -193,6 +197,13 @@ class IdeHistoryManager extends IdeAceManager {
   clearValidations(){ this.validations.length = 0 }
 
 
+  makeDirty(isDirty=true){
+    super.makeDirty(isDirty)
+    if(isDirty){
+      this._getJValidationButton().addClass("dirty-validation")
+    }
+  }
+
 
   setupHistoryBtn(jHistItem, [done, time, code]){
     jHistItem.text(time)
@@ -262,20 +273,21 @@ class IdeFeedbackManager extends IdeHistoryManager {
     if(runtime.stopped || !step) return
 
     const playing = this.running.isPlaying
-    const intro   = playing ? "" : CONFIG.lang.validation.msg
     const section = CONFIG.lang[step].msg
-    const ok      = CONFIG.lang.successMsg.msg
+    const isDone  = this.storage.done > 0
+    const okMsg   = CONFIG.lang.successMsg.msg
+    const intro   = playing ? "" : CONFIG.lang.validation.msg
 
-    let msg = `${ intro }${ section }: ${ ok }`   // Default section message
-    if(!code) msg = ""                            // No default message if no code in the section...
-    if(playing && !this.hasCheckBtn){             // ...but ensure the default ending message is shown,
-      msg = CONFIG.lang.successMsgNoTests.msg     //    if this is "playing" and nothing else to do after.
+    let msg = `${ intro }${ section }: ${ okMsg }`  // Default section message
+    if(!code) msg = ""                              // No default message if no code in the section...
+    if(playing && !this.hasCheckBtn){               // ...but ensure the default ending message is shown,
+      msg = CONFIG.lang.successMsgNoTests.msg       //    if this is "playing" and nothing else to do after.
     }
 
     if(msg) this.terminalEcho(msg)
 
     // Prepare a "very final" message if needed:
-    if(playing && this.hasCheckBtn){
+    if(playing && this.hasCheckBtn && (!isDone || this.isDirty)){
       // If a validation button is present while running the public tests
       runtime.finalMsg = CONFIG.lang.unforgettable.msg
     }
@@ -718,6 +730,42 @@ class IdeRunnerLogic extends IdeFeedbackManager {
  * */
 export class IdeRunner extends IdeRunnerLogic {
 
+  static KEY_UP_NO_CHANGES = new Set(`
+    Control
+    Alt
+    AltGraph
+    Meta
+    CapsLock
+    NumLock
+    Shift
+    ContextMenu
+    F1
+    F2
+    F3
+    F4
+    F5
+    F6
+    F7
+    F8
+    F9
+    F10
+    F11
+    F12
+    Insert
+    PageUp
+    PageDown
+    End
+    Home
+    Escape
+  `.trim().split(/\s+/g))
+
+  static KEY_UP_ARROWS = new Set(`
+    ArrowLeft
+    ArrowRight
+    ArrowUp
+    ArrowDown
+  `.trim().split(/\s+/g))
+
 
   /**Process to "re-initiate" the internal state of the IDE (useful for testing) */
   _init(){
@@ -852,7 +900,7 @@ export class IdeRunner extends IdeRunnerLogic {
 
     // Add fullscreen activation binding, but NOT through the ACE editor commands
     // cannot control the exit :/ )
-    this.global.on('keyup', this.respondToEscapeKeyUp.bind(this))
+    this.global.on('keyup', this.respondToKeyUp.bind(this))
 
     // Bind editor extra buttons:
     this.global.find(".comment.tooltip" ).on("click", this.toggleComments.bind(this))
@@ -930,22 +978,32 @@ export class IdeRunner extends IdeRunnerLogic {
   }
 
 
-  async respondToEscapeKeyUp(event){
-    if(
-      event.key == 'Escape'
+  async respondToKeyUp(event){
+
+    const goFullScreen = (event.key == 'Escape'
       && !IdeFullScreenGlobalManager.someMenuOpened
       && !this.guiIdeFlags.escapeIdeSearch
       && !somethingFullScreen()
-    ){
+    )
+    const justMoving = (
+      this.constructor.KEY_UP_NO_CHANGES.has(event.key) ||
+      this.constructor.KEY_UP_ARROWS.has(event.key) && !event.altKey ||
+      event.ctrlKey && "acfhs Enter".includes(event.key) ||
+      event.key == 'Escape'
+    )
+
+    if(goFullScreen){
       this.requestFullScreen()
-      // The browser already handles on its own going out of fullscreen with escape => no else needed
+      // The browser already handles on its own going out of fullscreen with escape
+      // => no "else" needed for that
 
     }else if(event.altKey && event.key==':'){
       this.switchSplitScreenFromButton(event)
 
-    }else{
+    }else if(!justMoving){
       this.makeDirty()
     }
+
     this.guiIdeFlags.escapeIdeSearch = false
   }
 

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/js-per-pages/5-ideTester-ides_test.js

@@ -404,6 +404,13 @@ class IdeTesterGuiManager extends IdeRunner {
 
   _applyConfAndData(onLoad=false){
 
+    // Always reset the "done" state, to make tests independent of each others.
+    this.storage.done = 0
+    if('done' in this.conf){
+      this.storage.done = this.conf.done
+    }
+    this.updateValidationBtnColor()
+
     const hasSetMaxHide = 'set_max_and_hide' in this.conf
     if(onLoad || hasSetMaxHide){
       this.conf.reveal_corr_rems = false

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/js-scripts/subscriptions.js

@@ -119,7 +119,7 @@ CONFIG.ACE_COLOR_THEME.aceStyle = {
 
   /**Automatically define the position of the tooltip around the hovered element by mutation of pos
    * */
-  const getAnchorPoint=({width, height, top, left}, pagePos)=>{
+  const getAnchorPoint=({width, height, top, left}, pagePos, obj)=>{
     const pos   = defaultPos()
 
     pos.anchorX = Math.round(pagePos.left + width/2)
@@ -135,6 +135,10 @@ CONFIG.ACE_COLOR_THEME.aceStyle = {
     }else if (pointer.isRight){
       pos.translateX = -100
     }
+
+    const w = obj.dataset.tipWidth
+    if (w!==undefined) pos.width = w+'em'
+
     return pos
   }
 
@@ -167,9 +171,9 @@ CONFIG.ACE_COLOR_THEME.aceStyle = {
       // Positions & dimensions in viewport:
       const rect = this.getBoundingClientRect()
 
-      pos = getAnchorPoint(rect, pagePos)
+      pos = getAnchorPoint(rect, pagePos, this)
     }
-    tipSpan.text(this.dataset.tipTxt)
+    tipSpan.html(this.dataset.tipTxt)
     placement(pos)
   })
 

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/pyodide-css/0-generic.css

@@ -282,5 +282,5 @@ mais sans lien dessus */
 .tooltip.p5-btn > img { width: 24px; }
 
 
-#floating-tip { position: absolute; }
+#floating-tip { position: absolute; z-index: 1 }
 #floating-tip > span { visibility: unset; }

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/pyodide-css/history.css

@@ -22,7 +22,7 @@ If not, see <https://www.gnu.org/licenses/>.
   position: absolute;
   left: 50%;
   bottom: 50%;
-  z-index: 1;
+  z-index: 4;   /* above bare tooltips */
   background: var(--main-theme);
   border-radius: 10px;
   padding: var(--hist-size);

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyodide_mkdocs_theme/templates/pyodide-css/ide.css

@@ -189,6 +189,9 @@ div[class*='ace-'] .ace_gutter {
   margin-right: calc(var(--marg-split) - 1px);
 }
 
+.dirty-validation > img {
+  border: 3px solid orange;
+}
 
 /*
 -------------------------------------------------------------

{pyodide_mkdocs_theme-5.4.3 → pyodide_mkdocs_theme-5.4.5}/pyproject.toml

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

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