r28171 - /trunk/lib/system.py -- April 02, 2016 - 12:52

Author: tlinnet
Date: Sat Apr  2 12:52:04 2016
New Revision: 28171

URL: http://svn.gna.org/viewcvs/relax?rev=28171&view=rev
Log:
Adding a new file at lib/system.py.

This file will contain different functions related to python os and system 
related functions.
For example changing directory or printing working directory.


Added:
    trunk/lib/system.py

Added: trunk/lib/system.py
URL: http://svn.gna.org/viewcvs/relax/trunk/lib/system.py?rev=28171&view=auto
==============================================================================
--- trunk/lib/system.py (added)
+++ trunk/lib/system.py Sat Apr  2 12:52:04 2016
@@ -0,0 +1,52 @@
+###############################################################################
+#                                                                            
 #
+# Copyright (C) 2016 Troels Schwartz-Linnet                                  
 #
+#                                                                            
 #
+# This file is part of the program relax (http://www.nmr-relax.com).         
 #
+#                                                                            
 #
+# This program is free software: you can redistribute it and/or modify       
 #
+# it under the terms of the GNU General Public License as published by       
 #
+# the Free Software Foundation, either version 3 of the License, or          
 #
+# (at your option) any later version.                                        
 #
+#                                                                            
 #
+# This program is distributed in the hope that it will be useful,            
 #
+# but WITHOUT ANY WARRANTY; without even the implied warranty of             
 #
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              
 #
+# GNU General Public License for more details.                               
 #
+#                                                                            
 #
+# You should have received a copy of the GNU General Public License          
 #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.      
 #
+#                                                                            
 #
+###############################################################################
+
+# Module docstring.
+"""Module for various os and sys python module purposes."""
+
+# Python module imports.
+from os import chdir, getcwd
+
+# relax module imports.
+import lib.arg_check
+
+
+def cd(path):
+    """The equivalent of python module os.chdir(path).  Change the current 
working directory to the specified path.
+
+    @param path:       The path to the directory for the current working 
directory.
+    @type  path:       str
+    """
+
+    # Check that the path is a string.
+    lib.arg_check.is_str(path, name="path", can_be_none=False, 
raise_error=True)
+
+    # Replace any remains of " and '
+    path = path.replace('"', '').replace("'", "")
+
+    # Print previous current working directory.
+    print("The current working directory was: %s"%getcwd())
+
+    # Change the current working directory.
+    chdir(path)
+
+    # Print current working directory.
+    print("The current working directory is now changed to: %s"%getcwd())