Show More
@@ -565,6 +565,19 b' def make_user_ns(user_ns = None):' | |||||
565 | This builds a dict with the minimal information needed to operate as a |
|
565 | This builds a dict with the minimal information needed to operate as a | |
566 | valid IPython user namespace, which you can pass to the various embedding |
|
566 | valid IPython user namespace, which you can pass to the various embedding | |
567 | classes in ipython. |
|
567 | classes in ipython. | |
|
568 | ||||
|
569 | This API is currently deprecated. Use ipapi.make_user_namespaces() instead | |||
|
570 | to make both the local and global namespace objects simultaneously. | |||
|
571 | ||||
|
572 | :Parameters: | |||
|
573 | user_ns : dict-like, optional | |||
|
574 | The current user namespace. The items in this namespace should be | |||
|
575 | included in the output. If None, an appropriate blank namespace | |||
|
576 | should be created. | |||
|
577 | ||||
|
578 | :Returns: | |||
|
579 | A dictionary-like object to be used as the local namespace of the | |||
|
580 | interpreter. | |||
568 | """ |
|
581 | """ | |
569 |
|
582 | |||
570 | raise NotImplementedError |
|
583 | raise NotImplementedError | |
@@ -575,7 +588,20 b' def make_user_global_ns(ns = None):' | |||||
575 |
|
588 | |||
576 | Similar to make_user_ns(), but global namespaces are really only needed in |
|
589 | Similar to make_user_ns(), but global namespaces are really only needed in | |
577 | embedded applications, where there is a distinction between the user's |
|
590 | embedded applications, where there is a distinction between the user's | |
578 |
interactive namespace and the global one where ipython is running. |
|
591 | interactive namespace and the global one where ipython is running. | |
|
592 | ||||
|
593 | This API is currently deprecated. Use ipapi.make_user_namespaces() instead | |||
|
594 | to make both the local and global namespace objects simultaneously. | |||
|
595 | ||||
|
596 | :Parameters: | |||
|
597 | ns : dict, optional | |||
|
598 | The current user global namespace. The items in this namespace | |||
|
599 | should be included in the output. If None, an appropriate blank | |||
|
600 | namespace should be created. | |||
|
601 | ||||
|
602 | :Returns: | |||
|
603 | A true dict to be used as the global namespace of the interpreter. | |||
|
604 | """ | |||
579 |
|
605 | |||
580 | raise NotImplementedError |
|
606 | raise NotImplementedError | |
581 |
|
607 | |||
@@ -599,6 +625,20 b' def make_user_namespaces(user_ns = None,user_global_ns = None):' | |||||
599 | namespace synchronize with the globals dict somehow. |
|
625 | namespace synchronize with the globals dict somehow. | |
600 |
|
626 | |||
601 | Raises TypeError if the provided globals namespace is not a true dict. |
|
627 | Raises TypeError if the provided globals namespace is not a true dict. | |
|
628 | ||||
|
629 | :Parameters: | |||
|
630 | user_ns : dict-like, optional | |||
|
631 | The current user namespace. The items in this namespace should be | |||
|
632 | included in the output. If None, an appropriate blank namespace | |||
|
633 | should be created. | |||
|
634 | user_global_ns : dict, optional | |||
|
635 | The current user global namespace. The items in this namespace | |||
|
636 | should be included in the output. If None, an appropriate blank | |||
|
637 | namespace should be created. | |||
|
638 | ||||
|
639 | :Returns: | |||
|
640 | A tuple pair of dictionary-like object to be used as the local namespace | |||
|
641 | of the interpreter and a dict to be used as the global namespace. | |||
602 | """ |
|
642 | """ | |
603 |
|
643 | |||
604 | if user_ns is None: |
|
644 | if user_ns is None: |
General Comments 0
You need to be logged in to leave comments.
Login now