Source Code for Package roslib

 1  # Software License Agreement (BSD License) 
 2  # 
 3  # Copyright (c) 2008, Willow Garage, Inc. 
 4  # All rights reserved. 
 5  # 
 6  # Redistribution and use in source and binary forms, with or without 
 7  # modification, are permitted provided that the following conditions 
 8  # are met: 
 9  # 
10  #  * Redistributions of source code must retain the above copyright 
11  #    notice, this list of conditions and the following disclaimer. 
12  #  * Redistributions in binary form must reproduce the above 
13  #    copyright notice, this list of conditions and the following 
14  #    disclaimer in the documentation and/or other materials provided 
15  #    with the distribution. 
16  #  * Neither the name of Willow Garage, Inc. nor the names of its 
17  #    contributors may be used to endorse or promote products derived 
18  #    from this software without specific prior written permission. 
19  # 
20  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  # POSSIBILITY OF SUCH DAMAGE. 
32   
33  """ 
34  roslib is largely deprecated starting in the ROS Fuerte release. 
35   
36  roslib has a very important role in all Python code written for ROS: 
37  it contains the L{load_manifest()} method, which updates the 
38  PYTHONPATH based on a set of ROS Package manifest.xml files. 
39   
40  Beyond the important load_manifest() call, most of the rest of roslib 
41  consists of low-level libraries that 99% of ROS users need not 
42  interact with. These libraries are primarily to support higher-level 
43  ROS Python libraries, such as the rospy client library, as well as 
44  numerous ROS tools (e.g. rostopic). 
45   
46  """ 
47   
48  __version__ = '1.7.0' 
49   
50  from roslib.launcher import load_manifest  # noqa: F401 
51  # this import is necessary due to a bug in purge_build.py in our 
52  # debian assets. 
53  import roslib.stacks  # noqa: F401, I100 
54   
55  _is_interactive = False 
56   
57   
58 -def set_interactive(interactive): 
59      """ 
60      General API for a script specifying that it is being run in an 
61      interactive environment. Many libraries may wish to change their 
62      behavior based on being interactive (e.g. disabling signal 
63      handlers on Ctrl-C). 
64   
65      @param interactive: True if current script is being run in an interactive shell 
66      @type  interactive: bool 
67      """ 
68      global _is_interactive 
69      _is_interactive = interactive 
70   
71   
72 -def is_interactive(): 
73      """ 
74      General API for a script specifying that it is being run in an 
75      interactive environment. Many libraries may wish to change their 
76      behavior based on being interactive (e.g. disabling signal 
77      handlers on Ctrl-C). 
78   
79      @return: True if interactive flag has been set 
80      @rtype: bool 
81      """ 
82      return _is_interactive 
83