mirror of
https://github.com/chubin/cheat.sh.git
synced 2026-06-20 13:16:44 +02:00
Igor Chubin
109 lines
2.5 KiB
Python
109 lines
2.5 KiB
Python
"""
|
|
`Adapter`, base class of the adapters.
|
|
"""
|
|
|
|
import abc
|
|
import os
|
|
from six import with_metaclass
|
|
|
|
from globals import LOCAL_REPOSITORIES
|
|
|
|
class AdapterMC(type):
|
|
"""
|
|
Adapater Metaclass.
|
|
Defines string representation of adapters
|
|
"""
|
|
def __repr__(cls):
|
|
if hasattr(cls, '_class_repr'):
|
|
return getattr(cls, '_class_repr')()
|
|
return super(AdapterMC, cls).__repr__()
|
|
|
|
class Adapter(with_metaclass(AdapterMC, object)):
|
|
"""
|
|
An abstract class, defines methods:
|
|
|
|
(cheat sheets retrieval)
|
|
* get_list
|
|
* is_found
|
|
* is_cache_needed
|
|
|
|
(repositories management)
|
|
" fetch
|
|
* update
|
|
|
|
and several properties that have to be set in each adapter subclass.
|
|
|
|
"""
|
|
|
|
_adapter_name = None
|
|
_output_format = 'code'
|
|
_cache_needed = False
|
|
_repository_url = None
|
|
_local_repository_location = None
|
|
_cheatsheet_files_prefix = None
|
|
|
|
@classmethod
|
|
def _class_repr(cls):
|
|
return '[Adapter: %s (%s)]' % (cls._adapter_name, cls.__name__)
|
|
|
|
def __init__(self):
|
|
self._list = {None: self._get_list()}
|
|
|
|
@abc.abstractmethod
|
|
def _get_list(self, prefix=None):
|
|
return []
|
|
|
|
def get_list(self, prefix=None):
|
|
"""
|
|
Return available pages for `prefix`
|
|
"""
|
|
|
|
if prefix in self._list:
|
|
return self._list[prefix]
|
|
|
|
self._list[prefix] = set(self._get_list(prefix=prefix))
|
|
return self._list[prefix]
|
|
|
|
def is_found(self, topic):
|
|
"""
|
|
check if `topic` is available
|
|
CAUTION: only root is checked
|
|
"""
|
|
return topic in self._list[None]
|
|
|
|
def is_cache_needed(self):
|
|
"""
|
|
Return True if answers should be cached.
|
|
Return False if answers should not be cached.
|
|
"""
|
|
return self._cache_needed
|
|
|
|
@abc.abstractmethod
|
|
def _get_page(self, topic, request_options=None):
|
|
"""
|
|
Return page for `topic`
|
|
"""
|
|
pass
|
|
|
|
def _get_output_format(self, topic):
|
|
if '/' in topic:
|
|
subquery = topic.split('/')[-1]
|
|
else:
|
|
subquery = topic
|
|
|
|
if subquery in [':list']:
|
|
return 'text'
|
|
return self._output_format
|
|
|
|
def get_page_dict(self, topic, request_options=None):
|
|
"""
|
|
Return page dict for `topic`
|
|
"""
|
|
answer_dict = {
|
|
'topic': topic,
|
|
'topic_type': self._adapter_name,
|
|
'answer': self._get_page(topic, request_options=request_options),
|
|
'format': self._get_output_format(topic),
|
|
}
|
|
return answer_dict
|