.. _l-staticmethods:

Static Methods
==============

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| staticmethod                                                                                                                        | class parent                | truncated documentation                                                                                      |
+=====================================================================================================================================+=============================+==============================================================================================================+
| :py:meth:`_format_str <pyquickhelper.pycode.unittestclass.ExtTestCase._format_str>`                                                 | ExtTestCase                 | Returns ``s`` or ``'s'`` depending on the type.                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_strrep <pyquickhelper.ipythonhelper.interact.StaticInteract._get_strrep>`                                            | StaticInteract              | Need to match javascript string rep                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_key <pyquickhelper.pycode.profiling.ProfileNode._key>`                                                                   | ProfileNode                 |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_make_depart_admonition <pyquickhelper.sphinxext.sphinx_md_builder.MdTranslator._make_depart_admonition>`                 | MdTranslator                |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_make_depart_admonition <pyquickhelper.sphinxext.sphinx_rst_builder.RstTranslator._make_depart_admonition>`               | RstTranslator               |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_print_cache <pyquickhelper.server.documentation_server.DocumentationHandler._print_cache>`                               | DocumentationHandler        | Displays the most requested files.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_private_get_name <pyquickhelper.ipythonhelper.magic_parser.MagicCommandParser._private_get_name>`                        | MagicCommandParser          | guesses the name of a parameter knowning the argument given to :meth:`add_argument`                          |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`abs_path_join <pyquickhelper.pycode.unittestclass.ExtTestCase.abs_path_join>`                                                | ExtTestCase                 | Returns an absolute and normalized path from this location.                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`add_mapping <pyquickhelper.server.documentation_server.DocumentationHandler.add_mapping>`                                    | DocumentationHandler        | Adds a mapping associated to a local path to watch.                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`build_expression <pyquickhelper.filehelper.file_tree_node.FileTreeNode.build_expression>`                                    | FileTreeNode                | Builds a regular expression validating a list of extension.                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`build_tag <pyquickhelper.sphinxext.blog_post.BlogPost.build_tag>`                                                            | BlogPost                    | Builds the tag for a post.                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`bytes2mapping <pyquickhelper.filehelper.transfer_api.MockTransferAPI.bytes2mapping>`                                         | MockTransferAPI             | Deserializes a mapping.                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`bytes2mapping <pyquickhelper.filehelper.transfer_api.TransferAPI.bytes2mapping>`                                             | TransferAPI                 | Deserializes a mapping.                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`category2url <pyquickhelper.sphinxext.blog_post_list.BlogPostList.category2url>`                                             | BlogPostList                | Removes accents and spaces to get a clean url.                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`checksum_md5 <pyquickhelper.filehelper.transfer_api.MockTransferAPI.checksum_md5>`                                           | MockTransferAPI             | Computes MD5 for a file.                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`checksum_md5 <pyquickhelper.filehelper.transfer_api.TransferAPI.checksum_md5>`                                               | TransferAPI                 | Computes MD5 for a file.                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`codediff_parser <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.codediff_parser>`                                    | MagicDiff                   | Defines the way to parse the magic command ``%codediff``.                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`compress_parser <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.compress_parser>`                            | MagicCompress               | defines the way to parse the magic command ``%compress``                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`create <pyquickhelper.helpgen.sphinxm_mock_app.MockSphinxApp.create>`                                                        | MockSphinxApp               | Creates a :class:`MockSphinxApp` for :epkg:`Sphinx`.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`decrypt_file_parser <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.decrypt_file_parser>`                          | MagicCrypt                  | defines the way to parse the magic command ``%decrypt_file``                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`divide_list <pyquickhelper.sphinxext.blog_post_list.BlogPostList.divide_list>`                                               | BlogPostList                | Divides a list into buckets of *division* items.                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`encrypt_file_parser <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.encrypt_file_parser>`                          | MagicCrypt                  | defines the way to parse the magic command ``%encrypt_file``                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`endecrypt_file_parser <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.endecrypt_file_parser>`                      | MagicCrypt                  | defines the way to parse the magic command ``%encrypt_file`` and ``%decrypt_file``                           |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`execute <pyquickhelper.server.documentation_server.DocumentationHandler.execute>`                                            | DocumentationHandler        | Locally executes a python script.                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`filter_node_ <pyquickhelper.pycode.profiling.ProfileNode.filter_node_>`                                                      | ProfileNode                 | Filters out node to be displayed by default.                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`getForFd <pyquickhelper.loghelper.run_cmd._AsyncLineReader.getForFd>`                                                        | _AsyncLineReader            |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`get_cell_code <pyquickhelper.ipythonhelper.notebook_runner.NotebookRunner.get_cell_code>`                                    | NotebookRunner              | Returns the code of a cell.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`get_cmd_custom <pyquickhelper.jenkinshelper.jenkins_server.JenkinsExt.get_cmd_custom>`                                       | JenkinsExt                  | Custom script for :epkg:`Jenkins`.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`get_from_cache <pyquickhelper.server.documentation_server.DocumentationHandler.get_from_cache>`                              | DocumentationHandler        | Retrieves a file from the cache if it was cached, it the file was added later than a day, it returns None.   |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`get_ftype <pyquickhelper.server.documentation_server.DocumentationHandler.get_ftype>`                                        | DocumentationHandler        | defines the header to send (type of files) based on path                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`get_label <pyquickhelper.helpgen.utils_sphinx_doc_helpers.IndexInformation.get_label>`                                       | IndexInformation            | Returns a new label given the existing ones.                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`get_mappings <pyquickhelper.server.documentation_server.DocumentationHandler.get_mappings>`                                  | DocumentationHandler        | Returns a copy of the mappings.                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`hash_string <pyquickhelper.jenkinshelper.jenkins_server.JenkinsExt.hash_string>`                                             | JenkinsExt                  | Hashes a string.                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`html_code_renderer <pyquickhelper.server.documentation_server.DocumentationHandler.html_code_renderer>`                      | DocumentationHandler        | Produces a html code for code.                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`htmlhelp_parser <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.htmlhelp_parser>`                         | MagicClassExample           | Defines the way to parse the magic command ``%htmlhelp``.                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`mapping2bytes <pyquickhelper.filehelper.transfer_api.MockTransferAPI.mapping2bytes>`                                         | MockTransferAPI             | Serializes a mapping.                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`mapping2bytes <pyquickhelper.filehelper.transfer_api.TransferAPI.mapping2bytes>`                                             | TransferAPI                 | Serializes a mapping.                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`process_html_path <pyquickhelper.server.documentation_server.DocumentationHandler.process_html_path>`                        | DocumentationHandler        | Processes a :epkg:`HTML` content, replaces path which are relative to the root and not the project.          |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`produce_aggregated_post_page <pyquickhelper.sphinxext.blog_post_list.BlogPostList.produce_aggregated_post_page>`             | BlogPostList                | Writes the content of an aggregate page of blog posts.                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`profile <pyquickhelper.pycode.unittestclass.ExtTestCase.profile>`                                                            | ExtTestCase                 | Profiles the execution of a function with function :func:`profile <pyquickhelper.pycode.profiling.profile>`. |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`read_json <pyquickhelper.filehelper.transfer_api.TransferAPI_FileInfo.read_json>`                                            | TransferAPI_FileInfo        | Retrieves information from a :epkg:`json` string.                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`reformat <pyquickhelper.sphinxext.sphinx_autosignature.AutoSignatureDirective.reformat>`                                     | AutoSignatureDirective      | Formats the number of spaces in front every line to be equal to a specific value.                            |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`setUpClass <pyquickhelper.pycode.unittestclass.ExtTestCase.setUpClass>`                                                      | ExtTestCase                 | Filters out *FutureWarning*, *PendingDeprecationWarning*.                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`stat <pyquickhelper.sphinxext.import_object_helper._Types.stat>`                                                             | _Types                      |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`strdiff_parser <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.strdiff_parser>`                                      | MagicDiff                   | Defines the way to parse the magic command ``%strdiff``.                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`tearDownClass <pyquickhelper.pycode.unittestclass.ExtTestCase.tearDownClass>`                                                | ExtTestCase                 | Stops filtering out *FutureWarning*, *PendingDeprecationWarning*.                                            |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`textdiff_parser <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.textdiff_parser>`                                    | MagicDiff                   | Defines the way to parse the magic command ``%textdiff``.                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`update_cache <pyquickhelper.server.documentation_server.DocumentationHandler.update_cache>`                                  | DocumentationHandler        | Updates the cache.                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`v2s <pyquickhelper.server.filestore_sqlite.SqlLite3FileStore.v2s>`                                                           | SqlLite3FileStore           |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`write_additional_files <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.write_additional_files>` | CustomSingleFileHTMLBuilder |                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`write_aggregated_post_list <pyquickhelper.sphinxext.blog_post_list.BlogPostList.write_aggregated_post_list>`                 | BlogPostList                | Writes list of posts in an aggregated manners.                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------+