File: PKG-INFO

package info (click to toggle)
python-shellescape 3.4.1-1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 92 kB
  • ctags: 24
  • sloc: python: 64; makefile: 4
file content (103 lines) | stat: -rw-r--r-- 3,659 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
Metadata-Version: 1.1
Name: shellescape
Version: 3.4.1
Summary: Shell escape a string to safely use it as a token in a shell command (backport of Python shlex.quote for Python versions 2.x & < 3.3)
Home-page: https://github.com/chrissimpkins/shellescape
Author: Christopher Simpkins
Author-email: git.simpkins@gmail.com
License: MIT license
Description: Source Repository: https://github.com/chrissimpkins/shellescape
        
        Description
        -----------
        
        The shellescape Python module defines the ``shellescape.quote()`` function that returns a shell-escaped version of a Python string.  This is a backport of the ``shlex.quote()`` function from Python 3.4.3 that makes it accessible to users of Python 3 versions < 3.3 and all Python 2.x versions.
        
        quote(s)
        --------
        
        From the Python documentation:
        
        Return a shell-escaped version of the string s. The returned value is a string that can safely be used as one token in a shell command line, for cases where you cannot use a list.
        
        This idiom would be unsafe:
        
        .. code-block:: python
        
        	>>> filename = 'somefile; rm -rf ~'
        	>>> command = 'ls -l {}'.format(filename)
        	>>> print(command)  # executed by a shell: boom!
        	ls -l somefile; rm -rf ~
        
        
        ``quote()`` lets you plug the security hole:
        
        .. code-block:: python
        
        	>>> command = 'ls -l {}'.format(quote(filename))
        	>>> print(command)
        	ls -l 'somefile; rm -rf ~'
        	>>> remote_command = 'ssh home {}'.format(quote(command))
        	>>> print(remote_command)
        	ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"''
        
        
        The quoting is compatible with UNIX shells and with ``shlex.split()``:
        
        .. code-block:: python
        
        	>>> remote_command = split(remote_command)
        	>>> remote_command
        	['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]
        	>>> command = split(remote_command[-1])
        	>>> command
        	['ls', '-l', 'somefile; rm -rf ~']
        
        
        Usage
        -----
        
        Include ``shellescape`` in your project setup.py file ``install_requires`` dependency definition list:
        
        .. code-block:: python
        
        	setup(
        	    ...
        	    install_requires=['shellescape'],
        	    ...
        	)
        
        
        Then import the ``quote`` function into your module(s) and use it as needed:
        
        .. code-block:: python
        
        	#!/usr/bin/env python
        	# -*- coding: utf-8 -*-
        
        	from shellescape import quote
        
        	filename = "somefile; rm -rf ~"
        	escaped_shell_command = 'ls -l {}'.format(quote(filename))
        
        
        Issue Reporting
        ---------------
        
        Issue reporting is available on the `GitHub repository <https://github.com/chrissimpkins/shellescape/issues>`_
        
        
        
Keywords: shell,quote,escape,backport,command line,command,subprocess
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows