Coverage for local/lib/python2.7/site-packages/sage/libs/gap/assigned_names.py : 68%

""" 

List of assigned names in GAP 

EXAMPLES:: 

sage: from sage.libs.gap.assigned_names import KEYWORDS, GLOBALS, FUNCTIONS 

sage: 'fi' in KEYWORDS 

True 

sage: 'ZassenhausIntersection' in GLOBALS 

True 

sage: 'SubdirectProduct' in FUNCTIONS 

True 

""" 

############################################################################### 

# Copyright (C) 2016, Volker Braun <vbraun.name@gmail.com> 

# 

# Distributed under the terms of the GNU General Public License (GPL) 

# as published by the Free Software Foundation; either version 2 of 

# the License, or (at your option) any later version. 

# http://www.gnu.org/licenses/ 

############################################################################### 

from six.moves import cPickle 

import string 

from sage.libs.gap.libgap import libgap 

from sage.libs.gap.saved_workspace import workspace 

NamesGVars = libgap.function_factory('NamesGVars') 

Filtered =libgap.function_factory('Filtered') 

ValueGlobal = libgap.function_factory('ValueGlobal') 

IsBoundGlobal = libgap.function_factory('IsBoundGlobal') 

IsFunction = libgap.function_factory('IsFunction') 

IsDocumentedWord = libgap.function_factory('IsDocumentedWord') 

def load_or_compute(name, function): 

""" 

Helper to load a cached value or compute it 

INPUT: 

- ``name`` -- string. Part of the cache filename 

- ``function`` -- function. To compute the value if not cached. 

OUTPUT: 

The value of ``function``, possibly cached. 

EXAMPLES:: 

sage: from sage.libs.gap.assigned_names import GLOBALS 

sage: len(GLOBALS) > 1000 # indirect doctest 

True 

sage: from sage.libs.gap.saved_workspace import workspace 

sage: workspace(name='globals') 

('...', True) 

""" 

filename, up_to_date = workspace(name=name) 

if up_to_date: 

with open(filename, 'rb') as f: 

return cPickle.load(f) 

else: 

value = function() 

from sage.misc.temporary_file import atomic_write 

with atomic_write(filename) as f: 

cPickle.dump(value, f) 

return value 

def list_keywords(): 

""" 

Return the GAP reserved keywords 

OUTPUT: 

Tuple of strings. 

EXAMPLES:: 

sage: from sage.libs.gap.assigned_names import KEYWORDS 

sage: 'fi' in KEYWORDS # indirect doctest 

True 

""" 

keywords = libgap.get_global('GAPInfo')['Keywords'].sage() 

return tuple(sorted(keywords)) 

KEYWORDS = list_keywords() 

def list_globals(): 

""" 

Return the GAP reserved keywords 

OUTPUT: 

Tuple of strings. 

EXAMPLES:: 

sage: from sage.libs.gap.assigned_names import GLOBALS 

sage: 'ZassenhausIntersection' in GLOBALS # indirect doctest 

True 

""" 

gvars = set( 

name.sage() for name in NamesGVars() 

if IsBoundGlobal(name) 

) 

gvars.difference_update(KEYWORDS) 

return tuple(sorted(gvars)) 

GLOBALS = load_or_compute('globals', list_globals) 

def list_functions(): 

""" 

Return the GAP documented global functions 

OUTPUT: 

Tuple of strings. 

EXAMPLES:: 

sage: from sage.libs.gap.assigned_names import FUNCTIONS 

sage: 'IsBound' in FUNCTIONS # is a keyword 

False 

sage: 'SubdirectProduct' in FUNCTIONS # indirect doctest 

True 

""" 

fnames = set(GLOBALS).difference(KEYWORDS) 

documented = Filtered(list(fnames), IsDocumentedWord) 

return tuple(sorted(documented.sage())) 

FUNCTIONS = load_or_compute('functions', list_functions)