upstream/ipython Files · IPython/utils/tests/test_tempdir.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Nikita Kniazev - - Load All Authors

File last commit:

r27126:8e428a71


                r28197:ad452c1d

Download file

             test_tempdir.py
        
                    29 lines
            
             | 1.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / tests / test_tempdir.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #-----------------------------------------------------------------------------

      #  Copyright (C) 2012-  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

      #-----------------------------------------------------------------------------

      from pathlib import Path

      from IPython.utils.tempdir import NamedFileInTemporaryDirectory

      from IPython.utils.tempdir import TemporaryWorkingDirectory

      def test_named_file_in_temporary_directory():

          with NamedFileInTemporaryDirectory('filename') as file:

              name = file.name

              assert not file.closed

              assert Path(name).exists()

              file.write(b'test')

          assert file.closed

          assert not Path(name).exists()

      def test_temporary_working_directory():

          with TemporaryWorkingDirectory() as directory:

              directory_path = Path(directory).resolve()

              assert directory_path.exists()

              assert Path.cwd().resolve() == directory_path

          assert not directory_path.exists()

          assert Path.cwd().resolve() != directory_path

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				#-----------------------------------------------------------------------------
				# Copyright (C) 2012- The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				from pathlib import Path

				from IPython.utils.tempdir import NamedFileInTemporaryDirectory
				from IPython.utils.tempdir import TemporaryWorkingDirectory


				def test_named_file_in_temporary_directory():
				with NamedFileInTemporaryDirectory('filename') as file:
				name = file.name
				assert not file.closed
				assert Path(name).exists()
				file.write(b'test')
				assert file.closed
				assert not Path(name).exists()

				def test_temporary_working_directory():
				with TemporaryWorkingDirectory() as directory:
				directory_path = Path(directory).resolve()
				assert directory_path.exists()
				assert Path.cwd().resolve() == directory_path
				assert not directory_path.exists()
				assert Path.cwd().resolve() != directory_path