Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2024-10-01 01:35:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add some missing docstrings.

Browse Source
This commit is contained in:
Lazlo Westerhof 2015-06-25 21:55:29 +02:00
parent d50601f5bd
commit 7fada800f3
3 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
onionshare/helpers.py
View File

@ -27,6 +27,9 @@ sys.setdefaultencoding("utf-8")
def get_platform(): def get_platform():
"""
Returns the platform OnionShare is running on.
"""
p = platform.system() p = platform.system()
if p == 'Linux' and platform.uname()[0:2] == ('Linux', 'amnesia'): if p == 'Linux' and platform.uname()[0:2] == ('Linux', 'amnesia'):
p = 'Tails' p = 'Tails'
@ -40,14 +43,22 @@ if get_platform() == 'Darwin':
else: else:
osx_resources_dir = None osx_resources_dir = None
def get_onionshare_dir(): def get_onionshare_dir():
"""
Returns the OnionShare directory.
"""
if get_platform() == 'Darwin': if get_platform() == 'Darwin':
onionshare_dir = os.path.dirname(__file__) onionshare_dir = os.path.dirname(__file__)
else: else:
onionshare_dir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe()))) onionshare_dir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
return onionshare_dir return onionshare_dir
def get_html_path(filename): def get_html_path(filename):
"""
Returns the path of the html files.
"""
p = platform.system() p = platform.system()
if p == 'Darwin': if p == 'Darwin':
prefix = os.path.join(osx_resources_dir, 'html') prefix = os.path.join(osx_resources_dir, 'html')
@ -57,6 +68,9 @@ def get_html_path(filename):
def constant_time_compare(val1, val2): def constant_time_compare(val1, val2):
"""
Compares two values in constant time.
"""
_builtin_constant_time_compare = getattr(hmac, 'compare_digest', None) _builtin_constant_time_compare = getattr(hmac, 'compare_digest', None)
if _builtin_constant_time_compare is not None: if _builtin_constant_time_compare is not None:
return _builtin_constant_time_compare(val1, val2) return _builtin_constant_time_compare(val1, val2)
@ -74,6 +88,9 @@ def constant_time_compare(val1, val2):
def random_string(num_bytes, output_len=None): def random_string(num_bytes, output_len=None):
"""
Returns a random string with a specified number of bytes.
"""
b = os.urandom(num_bytes) b = os.urandom(num_bytes)
h = hashlib.sha256(b).digest()[:16] h = hashlib.sha256(b).digest()[:16]
s = base64.b32encode(h).lower().replace('=', '') s = base64.b32encode(h).lower().replace('=', '')
@ -83,6 +100,9 @@ def random_string(num_bytes, output_len=None):
def human_readable_filesize(b): def human_readable_filesize(b):
"""
Returns filesize in a human readable format.
"""
thresh = 1024.0 thresh = 1024.0
if b < thresh: if b < thresh:
return '{0:.1f} B'.format(b) return '{0:.1f} B'.format(b)
@ -96,6 +116,9 @@ def human_readable_filesize(b):
def is_root(): def is_root():
"""
Returns if user is root.
"""
return os.geteuid() == 0 return os.geteuid() == 0

7
onionshare/strings.py
View File

@ -24,6 +24,10 @@ strings = {}
def load_strings(default="en"): def load_strings(default="en"):
"""
Loads translated strings and fallback to English
if the translation does not exist.
"""
global strings global strings
p = helpers.get_platform() p = helpers.get_platform()
@ -55,6 +59,9 @@ def load_strings(default="en"):
def translated(k, gui=False): def translated(k, gui=False):
"""
Returns a translated string.
"""
if gui: if gui:
return strings[k].encode("utf-8").decode('utf-8', 'replace') return strings[k].encode("utf-8").decode('utf-8', 'replace')
else: else:

6
onionshare_gui/common.py
View File

@ -21,6 +21,9 @@ import os, sys, inspect, platform
from onionshare import helpers from onionshare import helpers
def get_onionshare_gui_dir(): def get_onionshare_gui_dir():
"""
Returns the OnionShare gui directory.
"""
p = helpers.get_platform() p = helpers.get_platform()
if p == 'Darwin': if p == 'Darwin':
onionshare_gui_dir = os.path.dirname(__file__) onionshare_gui_dir = os.path.dirname(__file__)
@ -32,6 +35,9 @@ onionshare_gui_dir = get_onionshare_gui_dir()
def get_image_path(filename): def get_image_path(filename):
"""
Returns the OnionShare image path.
"""
p = helpers.get_platform() p = helpers.get_platform()
if p == 'Linux' or p == 'Tails': if p == 'Linux' or p == 'Tails':
prefix = os.path.join(sys.prefix, 'share/onionshare/images') prefix = os.path.join(sys.prefix, 'share/onionshare/images')