-Ph?dZddlZddlZddlZddlZddlmZddlmZddl Z ddl m Z ddl mZddlmZe jjd Zd Zd Zd Zd ZdZdZdZdZdZdZdZdZ dZ!dS)a#Binder and Jupyterlite utility functions. Integration with Binder and Jupyterlite is on an experimental stage. Note that this API may change in the future. .. warning:: Binder is still beta technology, so there may be instability in the experience of users who click Binder links. N)Path)quote) ConfigError)glr_path_static)status_iteratorzsphinx-galleryc t|d}|d}tj||d}tj|t |d}|*d|d|g}|tjd}d|ddd |d |d t|d g}|d dur|dt|z }n|dt|z }|S)aGenerate a Binder URL according to the configuration in conf.py. Parameters ---------- fpath: str The path to the `.py` file for which a Binder badge will be generated. binder_conf: dict or None The Binder configuration dictionary. See `gen_binder_rst` for details. Returns ------- binder_url : str A URL that can be used to direct the user to the live Binder environment. filepath_prefix notebooks_dirsrc_dir.ipynbN/ binderhub_urlv2ghorgrepobranchuse_jupyter_labTz?urlpath=lab/tree/z ?filepath=) ospathrelpathjoinr with_suffixstripreplacesepr)fpath binder_conf gallery_conf fpath_prefix link_base relative_link path_link binder_urls b/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/sphinx_gallery/interactive_example.pygen_binder_urlr's>"01LO,IGOOE< +BCCM Y](;(;(G(G(Q(QRRIHHl0055yABB !!"&#..I  (       +h' ( (    J$%--=5+;+;=== 55#3#3555 ct|||}tjtj|dd}tjtj|dtj|s?tjtjtd|d |}|S)aGenerate the reST + link for the Binder badge. Parameters ---------- fpath: str The path to the `.py` file for which a Binder badge will be generated. binder_conf: dict or None If a dictionary it must have the following keys: 'binderhub_url' The URL of the BinderHub instance that's running a Binder service. 'org' The GitHub organization to which the documentation will be pushed. 'repo' The GitHub repository to which the documentation will be pushed. 'branch' The Git branch on which the documentation exists (e.g., gh-pages). 'dependencies' A list of paths to dependency files that match the Binderspec. gallery_conf : dict Sphinx-Gallery configuration dictionary. Returns ------- rst : str The reStructuredText for the Binder badge that links to this file. imageszbinder_badge_logo.svgTexist_okz .. container:: binder-badge .. image:: images/binder_badge_logo.svg :target: {} :alt: Launch binder :width: 150 px ) r'rrrdirnamemakedirsisfileshutilcopyfilerformat)rrr r% physical_pathrsts r&gen_binder_rstr5Qs< {LAAJGLL *AMK ..>>>> 7>>- ( (  GLL**,C D Dm    !  fZ Jr(c|dS|jjdvrdS|jj}|d}t |dksdSt ddt||t|dS)z1Copy all Binder requirements and notebooks files.Nhtml readthedocsbinderrzcopying binder requirements...whitecolor) buildernameconfigsphinx_gallery_conflenloggerinfo_copy_binder_reqs_copy_binder_notebooks)app exceptionr rs r&copy_binder_filesrIs {666:1Lx(K {  a   KK0K@@@c;'''3r(c|d}|D]f}tjtj|j|s"t d|gtj|jd}tj|d|D]:}tj tj|j||;dS)z@Copy Binder requirements files to a "binder" folder in the docs. dependencieszSCouldn't find the Binder requirements file: {}, did you specify the path correctly?r:Tr+N) rrexistsrsrcdirrr2outdirr.r0copy)rGr path_reqsr binder_folders r&rErEsN+Iw~~bgll3:t<<== 66tjtj||r\||r|S)zRemove files with `.ipynb` and directories named `images` from list of files. `contents` should be a list of files, which is returned after file removal. Used with the `shutil` "ignore" keyword to filter out non-ipynb files. r r*)endswithrrisdirrappend)rcontentscontents_returnentrys r&_remove_ipynb_filesrYs O * * >>( # # * xRW]]27<<e3L3L%M%M   " "5 ) ) ) ) r(c,|jj}|d}|d}tj|j|d}t j|dtj|dt|ttfs|g}t|dt|}|D]_}t jtj|j|tj||t `d S) zCopy Jupyter notebooks to the binder notebooks directory. Copy each output gallery directory structure but only including the Jupyter notebook files. gallery_dirsr:r T ignore_errorsr+zcopying binder notebooks...lengthignoreN)r@rArrrrNr0rmtreer. isinstancelisttuplerrBcopytreerMrY)rGr r[rr iteratori_folders r&rFrFs  :1L/Lx(KGLL[-IJJM M-t4444K ---- lT5M 2 2&$~ 3C z$check_binder_conf..sG8: O$//33r()zhttp://zhttps://z2did not supply a valid url, gave binderhub_url: {}r)zrequirements.txtzenvironment.yml DockerfilerKz>`dependencies` value should be a list of strings. Got type {}.r r notebooksrFcLg|]!}tj|"S)rrbasename)rlrms r& z%check_binder_conf..s(DDDB27++B//DDDr(c3 K|]}|vV dS)Nrr)rlrmpath_reqs_filenamess r&rnz$check_binder_conf..s)GGRr((GGGGGGr(zDid not find one of `requirements.txt` or `environment.yml` in the "dependencies" section of the binder configuration for Sphinx-Gallery. A path to at least one of these files must exist in your Binder dependencies.)rOrcdictrrBgetrUkeysanyr2strrdretype setdefault) r req_valuesoptional_valuesmissing_valuesvalkeyrequired_reqs_filesrPrvs ` @r&check_binder_confrs$+""1A1A1C1CK k4 ( (IGHHH ;1LKKJMMMON'' ??3   '  ! !# & & & >QPPPQQQ!!CC zO3 4 4ACAABB B 5 >U    @ G GO,     POON+I)S!! K &/ N##  D%= 1 1  L S SY     ,---?K888,e444DD)DDD GGGG3FGGG G G  6   r(cLd|jvo|jddu}|sdSd|_dS)zoConfigure 'jupyterlite_bind_ipynb_suffix' if jupyterlite enabled. Connected to "config-inited" event. jupyterlite_sphinx jupyterliteNF) extensionsrAjupyterlite_bind_ipynb_suffix)rGr@is_jupyterlite_enableds r& pre_configure_jupyterlite_sphinxrsH . B  &} 5T A " ,1F(((r(ct|jd||jd<|jddS|jg|_|j|jdddS)zCheck SG "jupyterlite" and update Jupyterlite config "jupyterlite_contents". Connected to "config-inited" event but lower priority so called after `pre_configure_jupyterlite_sphinx`. rNjupyterlite_contents)check_jupyterlite_confrArrU)rGr@s r&!post_configure_jupyterlite_sphinxr1s 1G"=1311F}-!-08 "*&(# &&"=12HIr(cddlm}|dS|jjdvrdS|jj}d|jvo |ddu}|sdStdd |d }|dd }tj |d tj |t|ttfs|g}t!|dt#|}|D]_}tjtj|j|tj||t,`|dd} | dS||d\} tj|dd} t/t1j| d } tdd | D]} t3| 5} t5j| }dddn #1swxYwY| || t3| d5} t5j|| ddddn #1swxYwYdS)zECreate Jupyterlite contents according to "jupyterlite" configuration.r)_get_callablesNr7rrz copying Jupyterlite contents ...r;r<r[rTr\z Copying Jupyterlite contents ...r^r`notebook_modification_functionz**z*.ipynb) recursivez#Modifying Jupyterlite notebooks ...w)indent)gen_rstrr>r?r@rArrCrDr0rbrr.rcrdrerrBrfrrrMrYsortedglobopenjsonloaddump)rGrHrr rr[ contents_dirrgrhrnotebook_patternnotebook_filename_listnotebook_filenamefnotebook_contents r&create_jupyterlite_contentsrGs'''''' {666:1L. 4  't 3 " KK2'KBBB/L ./EFL M,d3333K  lT5M 2 2&$~ 8\ARARH   GLLX . . GLLx 0 0&     &2-%@(&"&-(6|](S(S%#w||L$ BB#DI.>$$O$O$OPP KK5WKEEE355 # $ $ ,#y||  , , , , , , , , , , , , , , , '&'79JKKK #S ) ) 5Q I&! 4 4 4 4 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 55s$ G..G2 5G2 H99H= H= ctj||d}|dd}|tjd}tjtj|ddtj|}|tjd}|ddr|dz }n|d z }|d |}tjtj|d }t|d |}|S) a~Generate the reST + link for the Binder badge. Parameters ---------- fpath: str The path to the `.py` file for which a JupyterLite badge will be generated. gallery_conf : dict Sphinx-Gallery configuration dictionary. Returns ------- rst : str The reStructuredText for the JupyterLite badge that links to this file. r z.pyr rliterrz/labz /notebooksz/index.html?path=r*z .. container:: lite-badge .. image:: images/jupyterlite_badge_logo.svg :target: {} :alt: Launch JupyterLite :width: 150 px ) rrrrrrr-_add_jupyterlite_badge_logor2)rr r#notebook_location lite_root_urllite_url image_dirr4s r&gen_jupyterlite_rstrs2"GOOE< +BCCM%--eX>>)11"&#>>GOO  \),f55rwu7M7MM"))"&#66MM"#45& % EE2CEEH RW__U33X>>I *** !  fX Jr(c2tj|dtj|d}tj|sAt jtjtd|dSdS)NTr+zjupyterlite_badge_logo.svg)rr.rrr/r0r1r)rr3s r&rrsK D))))GLL,HIIM 7>>- ( (  GLL**,H I I=       r(c |d}n d|jvp|du}|rdSt|tstddddd}|}t |t |z }|r/tdt |dt||D]\}}| ||tj |j |d|d<|S) z4Return full JupyterLite configuration with defaults.NTrz'`jupyterlite_conf` must be a dictionaryr)rrrz?Found some unknown keys in sphinx_gallery_conf['jupyterlite']: z. Allowed keys are: )rrcrwrrOsetrrditemsr}rrrrM)jupyterlite_confrGis_jupyterlite_disabled conf_defaultsresult unknown_keysr default_values r&rrsU {"& ! 6 R:Jd:R t & - -ECDDD!7*.M  " " $ $Fv;;]!3!33L  7l## 7 7!%m!4!4 7 7   ,1133..]#}----%'W\\ F12&&F !" Mr()"__doc__rrrr0pathlibr urllib.parser sphinx.utilsphinx sphinx.errorsrrutilsrutillogging getLoggerrCr'r5rIrErYrFrrrrrrrrrr(r&rs   %%%%%%""""""   & &'7 8 8///d888v   &CCC$(   8;;;|111$,;5;5;5|///d   %%%%%r(