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

Merge pull request from fperez/cellmagics...

Merge pull request from fperez/cellmagics Refactoring of the magics system and implementation of cell magics. This PR completely refactors the magic system, finally moving the magic objects to standalone, independent objects instead of being the mixin class we'd had since the beginning of IPython. Now, a separate base class is provided in IPython.core.magic.Magics that users can subclass to create their own magics. Decorators are also provided to create magics from simple functions without the need for object orientation. All builtin magics now exist in a few subclasses that group together related functionality, and the new IPython.core.magics package has been created to organize this into smaller files. This cleanup was the last major piece of deep refactoring needed from the original 2001 codebase. Secondly, this PR introduces a new type of magic function, prefixed with `%%` instead of `%`, which operates at the cell level. A cell magic receives two arguments: the line it is called on (like a line magic) and the body of the cell below it. Cell magics are most natural in the notebook, but they also work in the terminal and qt console, with the usual approach of using a blank line to signal cell termination. This PR closes , or IPEP 1, where the design had been discussed.

Tim Couper - - Load All Authors

File last commit:

r6310:1ff2bdd6


                r7011:61eb2ffe

Download file

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

      import nose.tools as nt

      from IPython.utils.dir2 import dir2

      class Base(object):

          x = 1

          z = 23

      def test_base():

          res = dir2(Base())

          assert ('x' in res)

          assert ('z' in res)

          assert ('y' not in res)

          assert ('__class__' in res)

          nt.assert_equal(res.count('x'), 1)

          nt.assert_equal(res.count('__class__'), 1)

      def test_SubClass():

          class SubClass(Base):

              y = 2

          res = dir2(SubClass())

          assert ('y' in res)

          nt.assert_equal(res.count('y'), 1)

          nt.assert_equal(res.count('x'), 1)

      def test_SubClass_with_trait_names_method():

          class SubClass(Base):

              y = 2

              def trait_names(self):

                  return ['t', 'umbrella']

          res = dir2(SubClass())

          assert('trait_names' in res)

          assert('umbrella' in res)

          nt.assert_equal(res[-6:], ['t', 'trait_names','umbrella', 'x','y','z'])

          nt.assert_equal(res.count('t'), 1)

      def test_SubClass_with_trait_names_attr():

          # usecase: trait_names is used in a class describing psychological classification

          class SubClass(Base):

              y = 2

              trait_names = 44

          res = dir2(SubClass())

          assert('trait_names' in res)

	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

				import nose.tools as nt
				from IPython.utils.dir2 import dir2


				class Base(object):
				x = 1
				z = 23


				def test_base():
				res = dir2(Base())
				assert ('x' in res)
				assert ('z' in res)
				assert ('y' not in res)
				assert ('__class__' in res)
				nt.assert_equal(res.count('x'), 1)
				nt.assert_equal(res.count('__class__'), 1)

				def test_SubClass():

				class SubClass(Base):
				y = 2

				res = dir2(SubClass())
				assert ('y' in res)
				nt.assert_equal(res.count('y'), 1)
				nt.assert_equal(res.count('x'), 1)


				def test_SubClass_with_trait_names_method():

				class SubClass(Base):
				y = 2
				def trait_names(self):
				return ['t', 'umbrella']

				res = dir2(SubClass())
				assert('trait_names' in res)
				assert('umbrella' in res)
				nt.assert_equal(res[-6:], ['t', 'trait_names','umbrella', 'x','y','z'])
				nt.assert_equal(res.count('t'), 1)


				def test_SubClass_with_trait_names_attr():
				# usecase: trait_names is used in a class describing psychological classification

				class SubClass(Base):
				y = 2
				trait_names = 44

				res = dir2(SubClass())
				assert('trait_names' in res)