Datasets:

shamikbose89

/

pii_code

like 1

# -*- coding: utf-8 -*- import os import uuid import datetime from google.appengine.ext import webapp from google.appengine.api import users from google.appengine.ext import db from google.appengine.api import mail from google.appengine.ext.webapp import template from django.utils import simplejson as json from google.appengine.api import urlfetch import urllib import conf import app.FlyingClub import app.CoreHandler from app.models import Comment, Crew class AuthHandler(webapp.RequestHandler): ################################################################################################### ## Get Actions ################################################################################################### def get(self, section=None, page=None): #sessID = self.do_cookie_check() section = 'auth' template_vars = {} App = app.FlyingClub.FlyingClub(section, page) template_vars['app'] = App #tvars['appo'] = Appo #tvars['conf'] = conf #tvars['user'] = None #template_vars['crewID'] = crewID #f 'sessIdent' in self.request.cookies: #sessIdent = self.request.cookies['sessIdent'] #lse: # sessIdent = None ## Setup Section and Page #if section == None: #section = "index" #template_vars['section'] = section #template_vars['page'] = page ## Get Comments q = db.GqlQuery("SELECT * FROM Comment " + "WHERE section = :1 " + "ORDER BY dated DESC", section) results = q.fetch(50) #template_vars['comments'] = results ## Application Object #template_vars['page_title'] = Appo.title("/%s/" % section) ## Setup User + Aauth #user = users.get_current_user() #if not user: # template_vars['user'] = None # template_vars['login_url'] = users.create_login_url("/set_session/") #else: # template_vars['user'] = user # template_vars['logout_url'] = users.create_logout_url("/subscribe/") ## Sign In Section #if section == 'ssignin' : # if sessID: # self.redirect("/profile/") # return #template_vars['page_title'] = 'Sign In with OpenId' #if section == 'sdo_logout': # cook_str = 'sessID=%s; expires=Fri, 31-Dec-1980 23:59:59 GMT; Path=/;' % '' # self.response.headers.add_header( 'Set-Cookie', # cook_str # ) # self.redirect("/") # return #if section == 'sprofile': # if not sessID: # self.redirect("/signin/") # return #template_vars['welcome'] = True if self.request.get("welcome") == '1' else False #template_vars['page_title'] = 'My Profile' main_template = '%s.html' % (section) path = '/%s/' % (section) #template_vars['path'] = path template_path = os.path.join(os.path.dirname(__file__), '../templates/pages/%s' % main_template) self.response.out.write(template.render(template_path, template_vars)) ################################################################################################### ## Post Actions ################################################################################################### def post(self, page=None): if page == 'rpx': token = self.request.get('token') url = 'https://rpxnow.com/api/v2/auth_info' args = { 'format': 'json', 'apiKey': conf.RPX_API_KEY, 'token': token } r = urlfetch.fetch( url=url, payload=urllib.urlencode(args), method=urlfetch.POST, headers={'Content-Type':'application/x-www-form-urlencoded'} ) data = json.loads(r.content) if data['stat'] == 'ok': welcome = 0 unique_identifier = data['profile']['identifier'] q = db.GqlQuery("select * from Crew where ident= :1", unique_identifier) crew = q.get() if not crew: crew = Crew(ident=unique_identifier) crew.name = data['profile']['preferredUsername'] if data['profile'].has_key('email'): crew.email = data['profile']['email'] crew.put() welcome = 1 subject = "New Login: %s" % crew.name body = "New login on schedule" else: subject = "Return Login: %s" % crew.name body = "New login on schedule" sessID = str(crew.key()) cook_str = 'crewID=%s; expires=Fri, 31-Dec-2020 23:59:59 GMT; Path=/;' % crew.id() self.response.headers.add_header( 'Set-Cookie', cook_str ) mail.send_mail( sender = conf.EMAIL, to = "Dev dummy@email.com", subject = subject, body = body ) self.redirect("/profile/?welcome=%s" % welcome) return else: print section, page #self.redirect("/")

[['EMAIL_ADDRESS', 'dummy@email.com'], ['URL', "https://rpxnow.com/api/v2/auth_info'"], ['PERSON', "template_vars['app"], ['URL', 'users.cr'], ['URL', 'users.cr'], ['PERSON', '#'], ['DATE_TIME', '23:59:59 GMT'], ['URL', 'r.co'], ['PERSON', "data['profile']['identifier"], ['NRP', 'sessID'], ['DATE_TIME', '31-Dec-2020'], ['DATE_TIME', '23:59:59 GMT'], ['PERSON', 'EMAIL'], ['DATE_TIME', '31-Dec-1980'], ['URL', 'app.Co'], ['URL', 'app.mo'], ['URL', 'webapp.Re'], ['URL', 'self.do'], ['URL', 'self.request.co'], ['URL', 'self.request.co'], ['URL', 'db.Gq'], ['URL', 'users.ge'], ['URL', 'self.red'], ['URL', 'self.response.headers.ad'], ['URL', 'self.red'], ['URL', 'self.red'], ['URL', 'self.request.ge'], ['URL', 's.ht'], ['URL', 'os.path.jo'], ['URL', 'os.pa'], ['URL', 'self.re'], ['URL', 'template.re'], ['URL', 'self.request.ge'], ['URL', 'db.Gq'], ['URL', 'q.ge'], ['URL', 'crew.na'], ['URL', 'crew.na'], ['URL', 'crew.na'], ['URL', 'crew.ke'], ['URL', 'crew.id'], ['URL', 'self.response.headers.ad'], ['URL', 'mail.se'], ['URL', 'email.com'], ['URL', 'self.red'], ['URL', 'self.red']]

"""Core classes and exceptions for Simple-Salesforce""" # has to be defined prior to login import DEFAULT_API_VERSION = '29.0' import requests import json try: from urlparse import urlparse except ImportError: # Python 3+ from urllib.parse import urlparse from simple_salesforce.login import SalesforceLogin from simple_salesforce.util import date_to_iso8601, SalesforceError try: from collections import OrderedDict except ImportError: # Python < 2.7 from ordereddict import OrderedDict class Salesforce(object): """Salesforce Instance An instance of Salesforce is a handy way to wrap a Salesforce session for easy use of the Salesforce REST API. """ def __init__( self, username=None, password=None, security_token=None, session_id=None, instance=None, instance_url=None, organizationId=None, sandbox=False, version=DEFAULT_API_VERSION, proxies=None, session=None): """Initialize the instance with the given parameters. Available kwargs Password Authentication: * username -- the Salesforce username to use for authentication * password -- the password for the username * security_token -- the security token for the username * sandbox -- True if you want to login to `test.salesforce.com`, False if you want to login to `login.salesforce.com`. Direct Session and Instance Access: * session_id -- Access token for this session Then either * instance -- Domain of your Salesforce instance, i.e. `na1.salesforce.com` OR * instance_url -- Full URL of your instance i.e. `https://na1.salesforce.com Universal Kwargs: * version -- the version of the Salesforce API to use, for example `29.0` * proxies -- the optional map of scheme to proxy server * session -- Custom requests session, created in calling code. This enables the use of requets Session features not otherwise exposed by simple_salesforce. """ # Determine if the user passed in the optional version and/or sandbox kwargs self.sf_version = version self.sandbox = sandbox self.proxies = proxies # Determine if the user wants to use our username/password auth or pass in their own information if all(arg is not None for arg in (username, password, security_token)): self.auth_type = "password" # Pass along the username/password to our login helper self.session_id, self.sf_instance = SalesforceLogin( session=session, username=username, password=password, security_token=security_token, sandbox=self.sandbox, sf_version=self.sf_version, proxies=self.proxies) elif all(arg is not None for arg in (session_id, instance or instance_url)): self.auth_type = "direct" self.session_id = session_id # If the user provides the full url (as returned by the OAuth interface for # example) extract the hostname (which we rely on) if instance_url is not None: self.sf_instance = urlparse(instance_url).hostname else: self.sf_instance = instance elif all(arg is not None for arg in (username, password, organizationId)): self.auth_type = 'ipfilter' # Pass along the username/password to our login helper self.session_id, self.sf_instance = SalesforceLogin( session=session, username=username, password=password, organizationId=organizationId, sandbox=self.sandbox, sf_version=self.sf_version, proxies=self.proxies) else: raise TypeError( 'You must provide login information or an instance and token' ) if self.sandbox: self.auth_site = 'https://test.salesforce.com' else: self.auth_site = 'https://login.salesforce.com' self.request = session or requests.Session() self.request.proxies = self.proxies self.headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer ' + self.session_id, 'X-PrettyPrint': '1' } self.base_url = ('https://{instance}/services/data/v{version}/' .format(instance=self.sf_instance, version=self.sf_version)) self.apex_url = ('https://{instance}/services/apexrest/' .format(instance=self.sf_instance)) def describe(self): url = self.base_url + "sobjects" result = self.request.get(url, headers=self.headers) if result.status_code != 200: raise SalesforceGeneralError(url, 'describe', result.status_code, result.content) json_result = result.json(object_pairs_hook=OrderedDict) if len(json_result) == 0: return None else: return json_result # SObject Handler def __getattr__(self, name): """Returns an `SFType` instance for the given Salesforce object type (given in `name`). The magic part of the SalesforceAPI, this function translates calls such as `salesforce_api_instance.Lead.metadata()` into fully constituted `SFType` instances to make a nice Python API wrapper for the REST API. Arguments: * name -- the name of a Salesforce object type, e.g. Lead or Contact """ # fix to enable serialization (https://github.com/heroku/simple-salesforce/issues/60) if name.startswith('__'): return super(Salesforce, self).__getattr__(name) return SFType(name, self.session_id, self.sf_instance, self.sf_version, self.proxies) # User utlity methods def set_password(self, user, password): """Sets the password of a user salesforce dev documentation link: https://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_user_password.htm Arguments: * user: the userID of the user to set * password: the new password """ url = self.base_url + 'sobjects/User/%s/password' % user params = { 'NewPassword' : password, } result = self.request.post(url, headers=self.headers, data=json.dumps(params)) # salesforce return 204 No Content when the request is successful if result.status_code != 200 and result.status_code != 204: raise SalesforceGeneralError(url, 'User', result.status_code, result.content) json_result = result.json(object_pairs_hook=OrderedDict) if len(json_result) == 0: return None else: return json_result def setPassword(self, user, password): import warnings warnings.warn( "This method has been deprecated. Please use set_password instread.", DeprecationWarning) return self.set_password(user, password) # Generic Rest Function def restful(self, path, params): """Allows you to make a direct REST call if you know the path Arguments: * path: The path of the request Example: sobjects/User/ABC123/password' * params: dict of parameters to pass to the path """ url = self.base_url + path result = self.request.get(url, headers=self.headers, params=params) if result.status_code != 200: raise SalesforceGeneralError(url, path, result.status_code, result.content) json_result = result.json(object_pairs_hook=OrderedDict) if len(json_result) == 0: return None else: return json_result # Search Functions def search(self, search): """Returns the result of a Salesforce search as a dict decoded from the Salesforce response JSON payload. Arguments: * search -- the fully formatted SOSL search string, e.g. `FIND {Waldo}` """ url = self.base_url + 'search/' # `requests` will correctly encode the query string passed as `params` params = {'q': search} result = self.request.get(url, headers=self.headers, params=params) if result.status_code != 200: raise SalesforceGeneralError(url, 'search', result.status_code, result.content) json_result = result.json(object_pairs_hook=OrderedDict) if len(json_result) == 0: return None else: return json_result def quick_search(self, search): """Returns the result of a Salesforce search as a dict decoded from the Salesforce response JSON payload. Arguments: * search -- the non-SOSL search string, e.g. `Waldo`. This search string will be wrapped to read `FIND {Waldo}` before being sent to Salesforce """ search_string = u'FIND {{{search_string}}}'.format(search_string=search) return self.search(search_string) # Query Handler def query(self, query, **kwargs): """Return the result of a Salesforce SOQL query as a dict decoded from the Salesforce response JSON payload. Arguments: * query -- the SOQL query to send to Salesforce, e.g. `SELECT Id FROM Lead WHERE Email = dummy@email.com"` """ url = self.base_url + 'query/' params = {'q': query} # `requests` will correctly encode the query string passed as `params` result = self.request.get(url, headers=self.headers, params=params, **kwargs) if result.status_code != 200: _exception_handler(result) return result.json(object_pairs_hook=OrderedDict) def query_more(self, next_records_identifier, identifier_is_url=False, **kwargs): """Retrieves more results from a query that returned more results than the batch maximum. Returns a dict decoded from the Salesforce response JSON payload. Arguments: * next_records_identifier -- either the Id of the next Salesforce object in the result, or a URL to the next record in the result. * identifier_is_url -- True if `next_records_identifier` should be treated as a URL, False if `next_records_identifer` should be treated as an Id. """ if identifier_is_url: # Don't use `self.base_url` here because the full URI is provided url = (u'https://{instance}{next_record_url}' .format(instance=self.sf_instance, next_record_url=next_records_identifier)) else: url = self.base_url + 'query/{next_record_id}' url = url.format(next_record_id=next_records_identifier) result = self.request.get(url, headers=self.headers, **kwargs) if result.status_code != 200: _exception_handler(result) return result.json(object_pairs_hook=OrderedDict) def query_all(self, query, **kwargs): """Returns the full set of results for the `query`. This is a convenience wrapper around `query(...)` and `query_more(...)`. The returned dict is the decoded JSON payload from the final call to Salesforce, but with the `totalSize` field representing the full number of results retrieved and the `records` list representing the full list of records retrieved. Arguments * query -- the SOQL query to send to Salesforce, e.g. `SELECT Id FROM Lead WHERE Email = dummy@email.com"` """ def get_all_results(previous_result, **kwargs): """Inner function for recursing until there are no more results. Returns the full set of results that will be the return value for `query_all(...)` Arguments: * previous_result -- the modified result of previous calls to Salesforce for this query """ if previous_result['done']: return previous_result else: result = self.query_more(previous_result['nextRecordsUrl'], identifier_is_url=True, **kwargs) result['totalSize'] += previous_result['totalSize'] # Include the new list of records with the previous list previous_result['records'].extend(result['records']) result['records'] = previous_result['records'] # Continue the recursion return get_all_results(result, **kwargs) # Make the initial query to Salesforce result = self.query(query, **kwargs) # The number of results might have exceeded the Salesforce batch limit # so check whether there are more results and retrieve them if so. return get_all_results(result, **kwargs) def apexecute(self, action, method='GET', data=None, **kwargs): """Makes an HTTP request to an APEX REST endpoint Arguments: * action -- The REST endpoint for the request. * method -- HTTP method for the request (default GET) * data -- A dict of parameters to send in a POST / PUT request * kwargs -- Additional kwargs to pass to `requests.request` """ result = self._call_salesforce(method, self.apex_url + action, data=json.dumps(data), **kwargs) if result.status_code == 200: try: response_content = result.json() except Exception: response_content = result.text return response_content def _call_salesforce(self, method, url, **kwargs): """Utility method for performing HTTP call to Salesforce. Returns a `requests.result` object. """ result = self.request.request(method, url, headers=self.headers, **kwargs) if result.status_code >= 300: _exception_handler(result) return result class SFType(object): """An interface to a specific type of SObject""" def __init__(self, object_name, session_id, sf_instance, sf_version='27.0', proxies=None): """Initialize the instance with the given parameters. Arguments: * object_name -- the name of the type of SObject this represents, e.g. `Lead` or `Contact` * session_id -- the session ID for authenticating to Salesforce * sf_instance -- the domain of the instance of Salesforce to use * sf_version -- the version of the Salesforce API to use * proxies -- the optional map of scheme to proxy server """ self.session_id = session_id self.name = object_name self.request = requests.Session() self.request.proxies = proxies self.base_url = (u'https://{instance}/services/data/v{sf_version}/sobjects/{object_name}/' .format(instance=sf_instance, object_name=object_name, sf_version=sf_version)) def metadata(self): """Returns the result of a GET to `.../{object_name}/` as a dict decoded from the JSON payload returned by Salesforce. """ result = self._call_salesforce('GET', self.base_url) return result.json(object_pairs_hook=OrderedDict) def describe(self): """Returns the result of a GET to `.../{object_name}/describe` as a dict decoded from the JSON payload returned by Salesforce. """ result = self._call_salesforce('GET', self.base_url + 'describe') return result.json(object_pairs_hook=OrderedDict) def describe_layout(self, record_id): """Returns the result of a GET to `.../{object_name}/describe/layouts/<recordid>` as a dict decoded from the JSON payload returned by Salesforce. """ result = self._call_salesforce('GET', self.base_url + 'describe/layouts/' + record_id) return result.json(object_pairs_hook=OrderedDict) def get(self, record_id): """Returns the result of a GET to `.../{object_name}/{record_id}` as a dict decoded from the JSON payload returned by Salesforce. Arguments: * record_id -- the Id of the SObject to get """ result = self._call_salesforce('GET', self.base_url + record_id) return result.json(object_pairs_hook=OrderedDict) def get_by_custom_id(self, custom_id_field, custom_id): """Returns the result of a GET to `.../{object_name}/{custom_id_field}/{custom_id}` as a dict decoded from the JSON payload returned by Salesforce. Arguments: * custom_id_field -- the API name of a custom field that was defined as an External ID * custom_id - the External ID value of the SObject to get """ custom_url = self.base_url + '{custom_id_field}/{custom_id}'.format( custom_id_field=custom_id_field, custom_id=custom_id) result = self._call_salesforce('GET', custom_url) return result.json(object_pairs_hook=OrderedDict) def create(self, data): """Creates a new SObject using a POST to `.../{object_name}/`. Returns a dict decoded from the JSON payload returned by Salesforce. Arguments: * data -- a dict of the data to create the SObject from. It will be JSON-encoded before being transmitted. """ result = self._call_salesforce('POST', self.base_url, data=json.dumps(data)) return result.json(object_pairs_hook=OrderedDict) def upsert(self, record_id, data, raw_response=False): """Creates or updates an SObject using a PATCH to `.../{object_name}/{record_id}`. If `raw_response` is false (the default), returns the status code returned by Salesforce. Otherwise, return the `requests.Response` object. Arguments: * record_id -- an identifier for the SObject as described in the Salesforce documentation * data -- a dict of the data to create or update the SObject from. It will be JSON-encoded before being transmitted. * raw_response -- a boolean indicating whether to return the response directly, instead of the status code. """ result = self._call_salesforce('PATCH', self.base_url + record_id, data=json.dumps(data)) return self._raw_response(result, raw_response) def update(self, record_id, data, raw_response=False): """Updates an SObject using a PATCH to `.../{object_name}/{record_id}`. If `raw_response` is false (the default), returns the status code returned by Salesforce. Otherwise, return the `requests.Response` object. Arguments: * record_id -- the Id of the SObject to update * data -- a dict of the data to update the SObject from. It will be JSON-encoded before being transmitted. * raw_response -- a boolean indicating whether to return the response directly, instead of the status code. """ result = self._call_salesforce('PATCH', self.base_url + record_id, data=json.dumps(data)) return self._raw_response(result, raw_response) def delete(self, record_id, raw_response=False): """Deletes an SObject using a DELETE to `.../{object_name}/{record_id}`. If `raw_response` is false (the default), returns the status code returned by Salesforce. Otherwise, return the `requests.Response` object. Arguments: * record_id -- the Id of the SObject to delete * raw_response -- a boolean indicating whether to return the response directly, instead of the status code. """ result = self._call_salesforce('DELETE', self.base_url + record_id) return self._raw_response(result, raw_response) def deleted(self, start, end): """Use the SObject Get Deleted resource to get a list of deleted records for the specified object. .../deleted/?start=2013-05-05T00:00:00+00:00&end=2013-05-10T00:00:00+00:00 * start -- start datetime object * end -- end datetime object """ url = self.base_url + 'deleted/?start={start}&end={end}'.format( start=date_to_iso8601(start), end=date_to_iso8601(end)) result = self._call_salesforce('GET', url) return result.json(object_pairs_hook=OrderedDict) def updated(self, start, end): """Use the SObject Get Updated resource to get a list of updated (modified or added) records for the specified object. .../updated/?start=2014-03-20T00:00:00+00:00&end=2014-03-22T00:00:00+00:00 * start -- start datetime object * end -- end datetime object """ url = self.base_url + 'updated/?start={start}&end={end}'.format( start=date_to_iso8601(start), end=date_to_iso8601(end)) result = self._call_salesforce('GET', url) return result.json(object_pairs_hook=OrderedDict) def _call_salesforce(self, method, url, **kwargs): """Utility method for performing HTTP call to Salesforce. Returns a `requests.result` object. """ headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer ' + self.session_id, 'X-PrettyPrint': '1' } result = self.request.request(method, url, headers=headers, **kwargs) if result.status_code >= 300: _exception_handler(result, self.name) return result def _raw_response(self, response, body_flag): """Utility method for processing the response and returning either the status code or the response object. Returns either an `int` or a `requests.Response` object. """ if not body_flag: return response.status_code else: return response class SalesforceAPI(Salesforce): """Depreciated SalesforceAPI Instance This class implements the Username/Password Authentication Mechanism using Arguments It has since been surpassed by the 'Salesforce' class, which relies on kwargs """ def __init__(self, username, password, security_token, sandbox=False, sf_version='27.0'): """Initialize the instance with the given parameters. Arguments: * username -- the Salesforce username to use for authentication * password -- the password for the username * security_token -- the security token for the username * sandbox -- True if you want to login to `test.salesforce.com`, False if you want to login to `login.salesforce.com`. * sf_version -- the version of the Salesforce API to use, for example "27.0" """ import warnings warnings.warn( "Use of login arguments has been depreciated. Please use kwargs", DeprecationWarning ) super(SalesforceAPI, self).__init__(username=username, password=password, security_token=security_token, sandbox=sandbox, version=sf_version) def _exception_handler(result, name=""): """Exception router. Determines which error to raise for bad results""" try: response_content = result.json() except Exception: response_content = result.text exc_map = { 300: SalesforceMoreThanOneRecord, 400: SalesforceMalformedRequest, 401: SalesforceExpiredSession, 403: SalesforceRefusedRequest, 404: SalesforceResourceNotFound, } exc_cls = exc_map.get(result.status_code, SalesforceGeneralError) raise exc_cls(result.url, result.status_code, name, response_content) class SalesforceMoreThanOneRecord(SalesforceError): """ Error Code: 300 The value returned when an external ID exists in more than one record. The response body contains the list of matching records. """ message = u"More than one record for {url}. Response content: {content}" class SalesforceMalformedRequest(SalesforceError): """ Error Code: 400 The request couldn't be understood, usually becaue the JSON or XML body contains an error. """ message = u"Malformed request {url}. Response content: {content}" class SalesforceExpiredSession(SalesforceError): """ Error Code: 401 The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode. """ message = u"Expired session for {url}. Response content: {content}" class SalesforceRefusedRequest(SalesforceError): """ Error Code: 403 The request has been refused. Verify that the logged-in user has appropriate permissions. """ message = u"Request refused for {url}. Response content: {content}" class SalesforceResourceNotFound(SalesforceError): """ Error Code: 404 The requested resource couldn't be found. Check the URI for errors, and verify that there are no sharing issues. """ message = u'Resource {name} Not Found. Response content: {content}' def __str__(self): return self.message.format(name=self.resource_name, content=self.content) class SalesforceGeneralError(SalesforceError): """ A non-specific Salesforce error. """ message = u'Error Code {status}. Response content: {content}' def __str__(self): return self.message.format(status=self.status, content=self.content)

[['EMAIL_ADDRESS', 'dummy@email.com'], ['EMAIL_ADDRESS', 'dummy@email.com'], ['URL', 'https://na1.salesforce.com'], ['URL', 'https://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_user_password.htm'], ['DATE_TIME', "'29.0'"], ['URL', 'urllib.pa'], ['NRP', 'OrderedDict'], ['PERSON', 'ordereddict import'], ['PERSON', 'OrderedDict'], ['LOCATION', 'security_token'], ['PERSON', 'simple_salesforce'], ['LOCATION', 'security_token'], ['LOCATION', 'security_token'], ['URL', 'self.au'], ['PERSON', 'self.sf_instance ='], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.request.ge'], ['URL', 'result.st'], ['URL', 'result.st'], ['PERSON', 'json_result = result.json(object_pairs_hook=OrderedDict'], ['LOCATION', 'SalesforceAPI'], ['PERSON', 'name.startswith'], ['LOCATION', 'self.sf_instance'], ['URL', 'self.ba'], ['URL', 'self.re'], ['URL', 'result.st'], ['PERSON', 'json_result = result.json(object_pairs_hook=OrderedDict'], ['URL', 'self.ba'], ['URL', 'self.request.ge'], ['URL', 'result.st'], ['PERSON', 'json_result = result.json(object_pairs_hook=OrderedDict'], ['URL', 'self.ba'], ['URL', 'self.request.ge'], ['URL', 'result.st'], ['PERSON', 'json_result = result.json(object_pairs_hook=OrderedDict'], ['PERSON', 'Waldo'], ['NRP', 'SOQL'], ['URL', 'self.ba'], ['URL', 'self.request.ge'], ['PERSON', 'exception_handler(result'], ['NRP', 'query_more(self'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'url.fo'], ['URL', 'self.request.ge'], ['PERSON', 'exception_handler(result'], ['NRP', 'SOQL'], ['NRP', 'previous_result'], ['PERSON', 'exception_handler(result'], ['LOCATION', 'session_id'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['LOCATION', 'custom_id_field'], ['PERSON', 'custom_id_field'], ['URL', 'self.ba'], ['LOCATION', 'custom_id_field'], ['LOCATION', 'custom_id_field'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['URL', 'self.ba'], ['PERSON', 'exception_handler(result'], ['LOCATION', 'security_token'], ['LOCATION', 'security_token'], ['LOCATION', 'security_token'], ['LOCATION', 'security_token'], ['PERSON', 'exception_handler(result'], ['LOCATION', 'SalesforceResourceNotFound'], ['URL', 'result.st'], ['URL', 'https://test.salesforce.com'], ['URL', 'https://login.salesforce.com'], ['URL', 'https://github.com/heroku/simple-salesforce/issues/60'], ['URL', 'test.salesforce.com'], ['URL', 'login.salesforce.com'], ['URL', 'na1.salesforce.com'], ['URL', 'self.sa'], ['URL', 'self.pro'], ['URL', 'self.au'], ['URL', 'self.se'], ['URL', 'self.sa'], ['URL', 'self.pro'], ['URL', 'self.se'], ['URL', 'self.au'], ['URL', 'self.se'], ['URL', 'self.sa'], ['URL', 'self.pro'], ['URL', 'self.sa'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.re'], ['URL', 'requests.Se'], ['URL', 'self.request.pro'], ['URL', 'self.pro'], ['URL', 'self.se'], ['URL', 'result.co'], ['URL', 'instance.Lead.me'], ['URL', 'name.st'], ['URL', 'self.se'], ['URL', 'self.pro'], ['URL', 'result.st'], ['URL', 'result.st'], ['URL', 'result.co'], ['URL', 'self.se'], ['URL', 'result.st'], ['URL', 'result.co'], ['URL', 'result.st'], ['URL', 'result.co'], ['URL', 'self.se'], ['URL', 'email.com'], ['URL', 'result.st'], ['URL', 'result.st'], ['URL', 'email.com'], ['URL', 'requests.re'], ['URL', 'result.st'], ['URL', 'requests.re'], ['URL', 'self.request.re'], ['URL', 'result.st'], ['URL', 'self.se'], ['URL', 'self.na'], ['URL', 'self.re'], ['URL', 'requests.Se'], ['URL', 'self.request.pro'], ['URL', 'requests.Re'], ['URL', 'requests.Re'], ['URL', 'requests.Re'], ['URL', 'requests.re'], ['URL', 'self.se'], ['URL', 'self.request.re'], ['URL', 'result.st'], ['URL', 'self.na'], ['URL', 'requests.Re'], ['URL', 'response.st'], ['URL', 'test.salesforce.com'], ['URL', 'login.salesforce.com'], ['URL', 'map.ge'], ['URL', 'result.st'], ['URL', 'self.message.fo'], ['URL', 'self.re'], ['URL', 'self.co'], ['URL', 'self.message.fo'], ['URL', 'self.st'], ['URL', 'self.co']]

""" YumConf - file ``/etc/yum.conf`` ================================ This module provides parsing for the ``/etc/yum.conf`` file. The ``YumConf`` class parses the information in the file ``/etc/yum.conf``. See the ``IniConfigFile`` class for more information on attributes and methods. Sample input data looks like:: [main] cachedir=/var/cache/yum/$basearch/$releasever keepcache=0 debuglevel=2 logfile=/var/log/yum.log exactarch=1 obsoletes=1 gpgcheck=1 plugins=1 installonly_limit=3 [rhel-7-server-rpms] metadata_expire = 86400 baseurl = https://cdn.redhat.com/content/rhel/server/7/$basearch name = Red Hat Enterprise Linux 7 Server (RPMs) gpgkey = PI:KEY enabled = 1 gpgcheck = 1 Examples: >>> yconf = shared[YumConf] >>> yconf.defaults() {'admin_token': 'ADMIN', 'compute_port': '8774'} >>> 'main' in yconf True >>> 'rhel-7-server-rpms' in yconf True >>> yconf.has_option('main', 'gpgcheck') True >>> yconf.has_option('main', 'foo') False >>> yconf.get('rhel-7-server-rpms', 'enabled') '1' >>> yconf.items('main') {'plugins': '1', 'keepcache': '0', 'cachedir': '/var/cache/yum/$basearch/$releasever', 'exactarch': '1', 'obsoletes': '1', 'installonly_limit': '3', 'debuglevel': '2', 'gpgcheck': '1', 'logfile': '/var/log/yum.log'} """ from insights.contrib.ConfigParser import NoOptionError from .. import parser, IniConfigFile from insights.specs import yum_conf @parser(yum_conf) class YumConf(IniConfigFile): """Parse contents of file ``/etc/yum.conf``.""" def parse_content(self, content): super(YumConf, self).parse_content(content) # File /etc/yum.conf may contain repos definitions. # Keywords 'gpgkey' and 'baseurl' might contain multiple # values separated by comma. Convert those values into a list. for section in self.sections(): for key in ('gpgkey', 'baseurl'): try: value = self.get(section, key) if value and isinstance(value, str): self.data.set(section, key, value.split(',')) except NoOptionError: pass

[['URL', 'https://cdn.redhat.com/content/rhel/server/7/$basearch'], ['PERSON', 'YumConf'], ['PERSON', 'admin_token'], ['PERSON', 'keepcache'], ['PERSON', 'exactarch'], ['PERSON', 'obsoletes'], ['LOCATION', 'insights.contrib'], ['PERSON', 'Parse'], ['IP_ADDRESS', 'e::\n\n '], ['URL', 'yum.co'], ['URL', 'yum.co'], ['URL', 'yum.co'], ['URL', 'yconf.de'], ['URL', 'yconf.ge'], ['URL', 'yconf.it'], ['URL', 'insights.contrib.Co'], ['URL', 'yum.co'], ['URL', 'yum.co'], ['URL', 'self.se'], ['URL', 'self.ge'], ['URL', 'self.data.se']]

""" Cisco_IOS_XR_man_xml_ttyagent_oper This module contains a collection of YANG definitions for Cisco IOS\-XR man\-xml\-ttyagent package operational data. This module contains definitions for the following management objects\: netconf\: NETCONF operational information xr\-xml\: xr xml Copyright (c) 2013\-2016 by Cisco Systems, Inc. All rights reserved. """ import re import collections from enum import Enum from ydk.types import Empty, YList, YLeafList, DELETE, Decimal64, FixedBitsDict from ydk.errors import YPYError, YPYModelError class XrXmlSessionAlarmRegisterEnum(Enum): """ XrXmlSessionAlarmRegisterEnum AlarmNotify .. data:: registered = 1 Registered .. data:: not_registered = 2 NotRegistered """ registered = 1 not_registered = 2 @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXmlSessionAlarmRegisterEnum'] class XrXmlSessionStateEnum(Enum): """ XrXmlSessionStateEnum SessionState .. data:: idle = 1 Idle .. data:: busy = 2 Busy """ idle = 1 busy = 2 @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXmlSessionStateEnum'] class Netconf(object): """ NETCONF operational information .. attribute:: agent NETCONF agent operational information **type**\: :py:class:`Agent <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.Netconf.Agent>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.agent = Netconf.Agent() self.agent.parent = self class Agent(object): """ NETCONF agent operational information .. attribute:: tty NETCONF agent over TTY **type**\: :py:class:`Tty <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.Netconf.Agent.Tty>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.tty = Netconf.Agent.Tty() self.tty.parent = self class Tty(object): """ NETCONF agent over TTY .. attribute:: sessions Session information **type**\: :py:class:`Sessions <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.Netconf.Agent.Tty.Sessions>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.sessions = Netconf.Agent.Tty.Sessions() self.sessions.parent = self class Sessions(object): """ Session information .. attribute:: session Session information **type**\: list of :py:class:`Session <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.Netconf.Agent.Tty.Sessions.Session>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session = YList() self.session.parent = self self.session.name = 'session' class Session(object): """ Session information .. attribute:: session_id <key> Session ID **type**\: int **range:** \-2147483648..2147483647 .. attribute:: admin_config_session_id Admin config session ID **type**\: str .. attribute:: alarm_notification is the session registered for alarm notifications **type**\: :py:class:`XrXmlSessionAlarmRegisterEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionAlarmRegisterEnum>` .. attribute:: client_address ip address of the client **type**\: str .. attribute:: client_port client's port **type**\: int **range:** 0..4294967295 .. attribute:: config_session_id Config session ID **type**\: str .. attribute:: elapsed_time Elapsed time(seconds) since a session is created **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: last_state_change Time(seconds) since last session state change happened **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: start_time session start time in seconds since the Unix Epoch **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: state state of the session idle/busy **type**\: :py:class:`XrXmlSessionStateEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionStateEnum>` .. attribute:: username Username **type**\: str .. attribute:: vrf_name VRF name **type**\: str """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session_id = None self.admin_config_session_id = None self.alarm_notification = None self.client_address = None self.client_port = None self.config_session_id = None self.elapsed_time = None self.last_state_change = None self.start_time = None self.state = None self.username = None self.vrf_name = None @property def _common_path(self): if self.session_id is None: raise YPYModelError('Key property session_id is None') return 'PI:KEY:session[Cisco-IOS-XR-man-xml-ttyagent-oper:session-id = ' + str(self.session_id) + ']' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session_id is not None: return True if self.admin_config_session_id is not None: return True if self.alarm_notification is not None: return True if self.client_address is not None: return True if self.client_port is not None: return True if self.config_session_id is not None: return True if self.elapsed_time is not None: return True if self.last_state_change is not None: return True if self.start_time is not None: return True if self.state is not None: return True if self.username is not None: return True if self.vrf_name is not None: return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['Netconf.Agent.Tty.Sessions.Session']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session is not None: for child_ref in self.session: if child_ref._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['Netconf.Agent.Tty.Sessions']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.sessions is not None and self.sessions._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['Netconf.Agent.Tty']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.tty is not None and self.tty._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['Netconf.Agent']['meta_info'] @property def _common_path(self): return '/Cisco-IOS-XR-man-xml-ttyagent-oper:netconf' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.agent is not None and self.agent._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['Netconf']['meta_info'] class XrXml(object): """ xr xml .. attribute:: agent XML agents **type**\: :py:class:`Agent <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.agent = XrXml.Agent() self.agent.parent = self class Agent(object): """ XML agents .. attribute:: default Default sessions information **type**\: :py:class:`Default <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Default>` .. attribute:: ssl SSL sessions information **type**\: :py:class:`Ssl <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Ssl>` .. attribute:: tty TTY sessions information **type**\: :py:class:`Tty <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Tty>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.default = XrXml.Agent.Default() self.default.parent = self self.ssl = XrXml.Agent.Ssl() self.ssl.parent = self self.tty = XrXml.Agent.Tty() self.tty.parent = self class Tty(object): """ TTY sessions information .. attribute:: sessions sessions information **type**\: :py:class:`Sessions <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Tty.Sessions>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.sessions = XrXml.Agent.Tty.Sessions() self.sessions.parent = self class Sessions(object): """ sessions information .. attribute:: session xml sessions information **type**\: list of :py:class:`Session <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Tty.Sessions.Session>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session = YList() self.session.parent = self self.session.name = 'session' class Session(object): """ xml sessions information .. attribute:: session_id <key> Session Id **type**\: int **range:** \-2147483648..2147483647 .. attribute:: admin_config_session_id Admin config session ID **type**\: str .. attribute:: alarm_notification is the session registered for alarm notifications **type**\: :py:class:`XrXmlSessionAlarmRegisterEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionAlarmRegisterEnum>` .. attribute:: client_address ip address of the client **type**\: str .. attribute:: client_port client's port **type**\: int **range:** 0..4294967295 .. attribute:: config_session_id Config session ID **type**\: str .. attribute:: elapsed_time Elapsed time(seconds) since a session is created **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: last_state_change Time(seconds) since last session state change happened **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: start_time session start time in seconds since the Unix Epoch **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: state state of the session idle/busy **type**\: :py:class:`XrXmlSessionStateEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionStateEnum>` .. attribute:: username Username **type**\: str .. attribute:: vrf_name VRF name **type**\: str """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session_id = None self.admin_config_session_id = None self.alarm_notification = None self.client_address = None self.client_port = None self.config_session_id = None self.elapsed_time = None self.last_state_change = None self.start_time = None self.state = None self.username = None self.vrf_name = None @property def _common_path(self): if self.session_id is None: raise YPYModelError('Key property session_id is None') return 'PI:KEY:session[Cisco-IOS-XR-man-xml-ttyagent-oper:session-id = ' + str(self.session_id) + ']' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session_id is not None: return True if self.admin_config_session_id is not None: return True if self.alarm_notification is not None: return True if self.client_address is not None: return True if self.client_port is not None: return True if self.config_session_id is not None: return True if self.elapsed_time is not None: return True if self.last_state_change is not None: return True if self.start_time is not None: return True if self.state is not None: return True if self.username is not None: return True if self.vrf_name is not None: return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Tty.Sessions.Session']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session is not None: for child_ref in self.session: if child_ref._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Tty.Sessions']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.sessions is not None and self.sessions._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Tty']['meta_info'] class Default(object): """ Default sessions information .. attribute:: sessions sessions information **type**\: :py:class:`Sessions <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Default.Sessions>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.sessions = XrXml.Agent.Default.Sessions() self.sessions.parent = self class Sessions(object): """ sessions information .. attribute:: session xml sessions information **type**\: list of :py:class:`Session <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Default.Sessions.Session>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session = YList() self.session.parent = self self.session.name = 'session' class Session(object): """ xml sessions information .. attribute:: session_id <key> Session Id **type**\: int **range:** \-2147483648..2147483647 .. attribute:: admin_config_session_id Admin config session ID **type**\: str .. attribute:: alarm_notification is the session registered for alarm notifications **type**\: :py:class:`XrXmlSessionAlarmRegisterEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionAlarmRegisterEnum>` .. attribute:: client_address ip address of the client **type**\: str .. attribute:: client_port client's port **type**\: int **range:** 0..4294967295 .. attribute:: config_session_id Config session ID **type**\: str .. attribute:: elapsed_time Elapsed time(seconds) since a session is created **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: last_state_change Time(seconds) since last session state change happened **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: start_time session start time in seconds since the Unix Epoch **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: state state of the session idle/busy **type**\: :py:class:`XrXmlSessionStateEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionStateEnum>` .. attribute:: username Username **type**\: str .. attribute:: vrf_name VRF name **type**\: str """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session_id = None self.admin_config_session_id = None self.alarm_notification = None self.client_address = None self.client_port = None self.config_session_id = None self.elapsed_time = None self.last_state_change = None self.start_time = None self.state = None self.username = None self.vrf_name = None @property def _common_path(self): if self.session_id is None: raise YPYModelError('Key property session_id is None') return 'PI:KEY:session[Cisco-IOS-XR-man-xml-ttyagent-oper:session-id = ' + str(self.session_id) + ']' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session_id is not None: return True if self.admin_config_session_id is not None: return True if self.alarm_notification is not None: return True if self.client_address is not None: return True if self.client_port is not None: return True if self.config_session_id is not None: return True if self.elapsed_time is not None: return True if self.last_state_change is not None: return True if self.start_time is not None: return True if self.state is not None: return True if self.username is not None: return True if self.vrf_name is not None: return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Default.Sessions.Session']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session is not None: for child_ref in self.session: if child_ref._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Default.Sessions']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.sessions is not None and self.sessions._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Default']['meta_info'] class Ssl(object): """ SSL sessions information .. attribute:: sessions sessions information **type**\: :py:class:`Sessions <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Ssl.Sessions>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.sessions = XrXml.Agent.Ssl.Sessions() self.sessions.parent = self class Sessions(object): """ sessions information .. attribute:: session xml sessions information **type**\: list of :py:class:`Session <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXml.Agent.Ssl.Sessions.Session>` """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session = YList() self.session.parent = self self.session.name = 'session' class Session(object): """ xml sessions information .. attribute:: session_id <key> Session Id **type**\: int **range:** \-2147483648..2147483647 .. attribute:: admin_config_session_id Admin config session ID **type**\: str .. attribute:: alarm_notification is the session registered for alarm notifications **type**\: :py:class:`XrXmlSessionAlarmRegisterEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionAlarmRegisterEnum>` .. attribute:: client_address ip address of the client **type**\: str .. attribute:: client_port client's port **type**\: int **range:** 0..4294967295 .. attribute:: config_session_id Config session ID **type**\: str .. attribute:: elapsed_time Elapsed time(seconds) since a session is created **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: last_state_change Time(seconds) since last session state change happened **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: start_time session start time in seconds since the Unix Epoch **type**\: int **range:** 0..4294967295 **units**\: second .. attribute:: state state of the session idle/busy **type**\: :py:class:`XrXmlSessionStateEnum <ydk.models.cisco_ios_xr.Cisco_IOS_XR_man_xml_ttyagent_oper.XrXmlSessionStateEnum>` .. attribute:: username Username **type**\: str .. attribute:: vrf_name VRF name **type**\: str """ _prefix = 'man-xml-ttyagent-oper' _revision = '2015-07-30' def __init__(self): self.parent = None self.session_id = None self.admin_config_session_id = None self.alarm_notification = None self.client_address = None self.client_port = None self.config_session_id = None self.elapsed_time = None self.last_state_change = None self.start_time = None self.state = None self.username = None self.vrf_name = None @property def _common_path(self): if self.session_id is None: raise YPYModelError('Key property session_id is None') return 'PI:KEY:session[Cisco-IOS-XR-man-xml-ttyagent-oper:session-id = ' + str(self.session_id) + ']' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session_id is not None: return True if self.admin_config_session_id is not None: return True if self.alarm_notification is not None: return True if self.client_address is not None: return True if self.client_port is not None: return True if self.config_session_id is not None: return True if self.elapsed_time is not None: return True if self.last_state_change is not None: return True if self.start_time is not None: return True if self.state is not None: return True if self.username is not None: return True if self.vrf_name is not None: return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Ssl.Sessions.Session']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.session is not None: for child_ref in self.session: if child_ref._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Ssl.Sessions']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.sessions is not None and self.sessions._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent.Ssl']['meta_info'] @property def _common_path(self): return 'PI:KEY' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.default is not None and self.default._has_data(): return True if self.ssl is not None and self.ssl._has_data(): return True if self.tty is not None and self.tty._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml.Agent']['meta_info'] @property def _common_path(self): return '/Cisco-IOS-XR-man-xml-ttyagent-oper:xr-xml' def is_config(self): ''' Returns True if this instance represents config data else returns False ''' return False def _has_data(self): if self.agent is not None and self.agent._has_data(): return True return False @staticmethod def _meta_info(): from ydk.models.cisco_ios_xr._meta import _Cisco_IOS_XR_man_xml_ttyagent_oper as meta return meta._meta_table['XrXml']['meta_info']

[['UK_NHS', '2147483648'], ['UK_NHS', '2147483648'], ['UK_NHS', '2147483648'], ['UK_NHS', '2147483648'], ['PERSON', 'Enum'], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['PERSON', 'class:`XrXmlSessionAlarmRegisterEnum'], ['DATE_TIME', 'seconds'], ['PERSON', 'class:`XrXmlSessionStateEnum'], ['DATE_TIME', "2015-07-30'"], ['PERSON', "Agent']['meta_info"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['PERSON', 'class:`XrXmlSessionAlarmRegisterEnum'], ['DATE_TIME', 'seconds'], ['PERSON', 'class:`XrXmlSessionStateEnum'], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['PERSON', 'class:`XrXmlSessionAlarmRegisterEnum'], ['DATE_TIME', 'seconds'], ['PERSON', 'class:`XrXmlSessionStateEnum'], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['DATE_TIME', "2015-07-30'"], ['PERSON', 'class:`XrXmlSessionAlarmRegisterEnum'], ['DATE_TIME', 'seconds'], ['PERSON', 'class:`XrXmlSessionStateEnum'], ['DATE_TIME', "2015-07-30'"], ['PERSON', "Agent']['meta_info"], ['IP_ADDRESS', ' '], ['IP_ADDRESS', 'e:: '], ['URL', 'ydk.er'], ['URL', 'ydk.models.ci'], ['URL', 'ydk.models.ci'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.Netconf.Ag'], ['URL', 'self.ag'], ['URL', 'Netconf.Ag'], ['URL', 'self.agent.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.Netconf.Agent.Tt'], ['URL', 'self.pa'], ['URL', 'self.tt'], ['URL', 'Netconf.Agent.Tt'], ['URL', 'self.tty.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.Netconf.Agent.Tty.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'Netconf.Agent.Tty.Se'], ['URL', 'self.sessions.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.Netconf.Agent.Tty.Sessions.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.session.pa'], ['URL', 'self.session.na'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'ydk.models.ci'], ['URL', 'Netconf.Agent.Tty.Sessions.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'Netconf.Agent.Tty.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'Netconf.Agent.Tt'], ['URL', 'self.tt'], ['URL', 'self.tt'], ['URL', 'ydk.models.ci'], ['URL', 'Netconf.Ag'], ['URL', 'self.ag'], ['URL', 'self.ag'], ['URL', 'ydk.models.ci'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Ag'], ['URL', 'self.ag'], ['URL', 'XrXml.Ag'], ['URL', 'self.agent.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.De'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Ag'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Tt'], ['URL', 'self.pa'], ['URL', 'self.de'], ['URL', 'XrXml.Agent.De'], ['URL', 'self.default.pa'], ['URL', 'XrXml.Ag'], ['URL', 'self.ssl.pa'], ['URL', 'self.tt'], ['URL', 'XrXml.Agent.Tt'], ['URL', 'self.tty.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Tty.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'XrXml.Agent.Tty.Se'], ['URL', 'self.sessions.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Tty.Sessions.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.session.pa'], ['URL', 'self.session.na'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Tty.Sessions.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Tty.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Tt'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Default.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'XrXml.Agent.Default.Se'], ['URL', 'self.sessions.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Default.Sessions.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.session.pa'], ['URL', 'self.session.na'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Default.Sessions.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Default.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.De'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Ssl.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'XrXml.Agent.Ssl.Se'], ['URL', 'self.sessions.pa'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'oper.XrXml.Agent.Ssl.Sessions.Se'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.session.pa'], ['URL', 'self.session.na'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'ydk.models.ci'], ['URL', 'xr.Ci'], ['URL', 'self.pa'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'self.ad'], ['URL', 'self.al'], ['URL', 'self.cl'], ['URL', 'self.cl'], ['URL', 'self.co'], ['URL', 'self.la'], ['URL', 'self.st'], ['URL', 'self.st'], ['URL', 'self.us'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Ssl.Sessions.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Agent.Ssl.Se'], ['URL', 'self.se'], ['URL', 'self.se'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Ag'], ['URL', 'self.de'], ['URL', 'self.de'], ['URL', 'self.tt'], ['URL', 'self.tt'], ['URL', 'ydk.models.ci'], ['URL', 'XrXml.Ag'], ['URL', 'self.ag'], ['URL', 'self.ag'], ['URL', 'ydk.models.ci']]

__author__ = 'Viktor Kerkez dummy@email.com' __contact__ = dummy@email.com' __date__ = '20 April 2010' __copyright__ = 'Copyright (c) 2010 Viktor Kerkez' import logging from django import forms from django.conf import settings from google.appengine.api import mail # perart imports from perart import models class PerArtForm(forms.ModelForm): tinymce = True class ProgramForm(PerArtForm): class Meta: model = models.Program exclude = ['url'] class ProjectForm(PerArtForm): class Meta: model = models.Project exclude = ['url'] class NewsForm(PerArtForm): class Meta: model = models.News exclude = ['url'] class MenuForm(PerArtForm): tinymce = False class Meta: model = models.Menu exclude = ['url'] class GalleryForm(PerArtForm): class Meta: model = models.Gallery exclude = ['url'] class NewsletterForm(forms.Form): name = forms.CharField(required=True) email = forms.EmailField(required=True) def send_email(self): try: mail.send_mail(dummy@email.com', to=settings.PERART_EMAIL, subject='"%(name)s" se prijavio za newsletter' % self.cleaned_data, body='Ime: %(name)s\nEmail: %(email)s' % self.cleaned_data) return True except: logging.exception('sending message failed') return False

[['EMAIL_ADDRESS', 'dummy@email.com'], ['EMAIL_ADDRESS', 'dummy@email.com'], ['EMAIL_ADDRESS', 'dummy@email.com'], ['PERSON', 'Viktor Kerkez'], ['DATE_TIME', "'20 April 2010'"], ['DATE_TIME', '2010'], ['PERSON', 'Viktor Kerkez'], ['URL', 'forms.Fo'], ['PERSON', 'PERART_EMAIL'], ['URL', 'email.com'], ['URL', 'email.com'], ['URL', 'django.co'], ['URL', 'forms.Mo'], ['URL', 'models.Pro'], ['URL', 'models.Pro'], ['URL', 'models.Ne'], ['URL', 'models.Me'], ['URL', 'models.Ga'], ['URL', 'forms.Ch'], ['URL', 'mail.se'], ['URL', 'email.com'], ['URL', 'settings.PE'], ['URL', 'self.cl'], ['URL', 'self.cl']]

#!/usr/bin/python # -*- coding: utf-8 -*- ############################################################################## # # Pedro Arroyo M dummy@email.com # Copyright (C) 2015 Mall Connection(<http://www.mallconnection.org>). # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero 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 Affero General Public License for more details. # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. # ############################################################################## from osv import osv from osv import fields class hr_family_responsibilities(osv.osv): ''' Open ERP Model ''' _name = 'hr.family.responsibilities' _description = 'openerpmodel' _columns = { 'name':fields.char('Name', size=64, required=True, readonly=False), 'type':fields.selection([ ('simple','simple responsibility'), ('maternal','maternal responsibility'), ('invalid','invalid responsibility'), ], 'State', select=True), 'relationship':fields.selection([ ('father','father'), ('son','son / daughter'), ('spouse','spouse'), ('Father in law','Father in law / mother in law'), ('son','son / daughter'), ('second','second'), ('Grandfather','Grandfather / Grandmother'), ('grandchild','grandchild / granddaughter'), ('sister','sister / brother'), ('brother in law','brother in law / sister in law'), ], 'Relationship', select=True, readonly=False), 'vat': fields.char('TIN', size=32, help="Tax Identification Number. Check the box if this contact is subjected to taxes. Used by the some of the legal statements."), 'employee_id': fields.many2one('hr.employee', string='Employee'), } hr_family_responsibilities()

[['EMAIL_ADDRESS', 'dummy@email.com'], ['DATE_TIME', '2015'], ['PERSON', "law','Father"], ['PERSON', "Grandfather','Grandfather"], ['URL', 'http://www.mallconnection.org'], ['URL', 'http://www.gnu.org/licenses/'], ['URL', 'email.com'], ['URL', 'hr.family.re'], ['URL', 'fields.ch'], ['URL', 'fields.se'], ['URL', 'fields.se'], ['URL', 'fields.ch'], ['URL', 'fields.ma']]

# -*- coding: utf-8 -*- # # diffoscope: in-depth comparison of files, archives, and directories # # Copyright © 2018 Chris Lamb dummy@email.com # # diffoscope 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. # # diffoscope 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 diffoscope. If not, see <https://www.gnu.org/licenses/>. import pytest from diffoscope.comparators.gnumeric import GnumericFile from ..utils.data import load_fixture, get_data from ..utils.tools import skip_unless_tools_exist from ..utils.nonexisting import assert_non_existing gnumeric1 = load_fixture('test1.gnumeric') gnumeric2 = load_fixture('test2.gnumeric') def test_identification(gnumeric1): assert isinstance(gnumeric1, GnumericFile) def test_no_differences(gnumeric1): difference = gnumeric1.compare(gnumeric1) assert difference is None @pytest.fixture def differences(gnumeric1, gnumeric2): return gnumeric1.compare(gnumeric2).details @skip_unless_tools_exist('ssconvert') def test_diff(differences): expected_diff = get_data('gnumeric_expected_diff') assert differences[0].unified_diff == expected_diff @skip_unless_tools_exist('ssconvert') def test_compare_non_existing(monkeypatch, gnumeric1): assert_non_existing(monkeypatch, gnumeric1, has_null_source=False)

[['EMAIL_ADDRESS', 'dummy@email.com'], ['PERSON', 'Chris Lamb'], ['PERSON', "@skip_unless_tools_exist('ssconvert"], ['PERSON', "@skip_unless_tools_exist('ssconvert"], ['URL', 'https://www.gnu.org/licenses/'], ['URL', 'email.com'], ['URL', 'diffoscope.comparators.gn'], ['URL', '..utils.to'], ['URL', '..utils.no'], ['URL', 'test1.gn'], ['URL', 'test2.gn'], ['URL', 'gnumeric1.com'], ['URL', 'pytest.fi'], ['URL', 'gnumeric1.com']]

''' xfilesharing XBMC Plugin Copyright (C) 2013-2014 ddurdle 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/>. ''' import cloudservice import os import re import urllib, urllib2 import cookielib import xbmc, xbmcaddon, xbmcgui, xbmcplugin # global variables PLUGIN_NAME = 'plugin.video.cloudstream' PLUGIN_URL = 'plugin://'+PLUGIN_NAME+'/' ADDON = xbmcaddon.Addon(id=PLUGIN_NAME) # helper methods def log(msg, err=False): if err: xbmc.log(ADDON.getAddonInfo('name') + ': ' + msg, xbmc.LOGERROR) else: xbmc.log(ADDON.getAddonInfo('name') + ': ' + msg, xbmc.LOGDEBUG) # # # class xfilesharing(cloudservice.cloudservice): # magic numbers MEDIA_TYPE_VIDEO = 1 MEDIA_TYPE_FOLDER = 0 ## # initialize (setting 1) username, 2) password, 3) authorization token, 4) user agent string ## def __init__(self, name, domain, user, password, auth, user_agent): return super(xfilesharing,self).__init__(name, domain, user, password, auth, user_agent) #return cloudservice.__init__(self,domain, user, password, auth, user_agent) ## # perform login ## def login(self): opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self.cookiejar)) # default User-Agent ('Python-urllib/2.6') will *not* work opener.addheaders = [('User-Agent', self.user_agent)] if self.domain == 'uptostream.com': self.domain = 'uptobox.com' if 'http://' in self.domain: url = self.domain else: url = 'http://' + self.domain + '/' values = { 'op' : 'login', 'login' : self.user, 'redirect' : url, 'password' : self.password } # try login try: response = opener.open(url,urllib.urlencode(values)) except urllib2.URLError, e: if e.code == 403: #login denied xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30017)) log(str(e), True) return response_data = response.read() response.close() loginResult = False #validate successful login for r in re.finditer('my_account', response_data, re.DOTALL): loginResult = True #validate successful login for r in re.finditer('logout', response_data, re.DOTALL): loginResult = True if (loginResult == False): xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30017)) log('login failed', True) return for cookie in self.cookiejar: for r in re.finditer(' ([^\=]+)\=([^\s]+)\s', str(cookie), re.DOTALL): cookieType,cookieValue = r.groups() if cookieType == 'xfss': self.auth = cookieValue if cookieType == 'xfsts': self.auth = cookieValue return ## # return the appropriate "headers" for FireDrive requests that include 1) user agent, 2) authorization cookie # returns: list containing the header ## def getHeadersList(self,referer=''): if ((self.auth != '' or self.auth != 0) and referer == ''): return { 'User-Agent' : self.user_agent, 'Cookie' : 'lang=english; login='+self.user+'; xfsts='+self.auth+'; xfss='+self.auth+';' } elif (self.auth != '' or self.auth != 0): return { 'User-Agent' : self.user_agent, 'Referer': referer, 'Cookie' : 'lang=english; login='+self.user+'; xfsts='+self.auth+'; xfss='+self.auth+';' } else: return { 'User-Agent' : self.user_agent } ## # return the appropriate "headers" for FireDrive requests that include 1) user agent, 2) authorization cookie # returns: URL-encoded header string ## def getHeadersEncoded(self, referer=''): return urllib.urlencode(self.getHeadersList(referer)) ## # retrieve a list of videos, using playback type stream # parameters: prompt for video quality (optional), cache type (optional) # returns: list of videos ## def getVideosList(self, folderID=0, cacheType=0): if 'http://' in self.domain: url = self.domain else: url = 'http://' + self.domain if 'streamcloud.eu' in self.domain: url = url + '/' # retrieve all documents if folderID == 0: url = url+'?op=my_files' else: url = url+'?op=my_files&fld_id='+folderID videos = {} if True: req = urllib2.Request(url, None, self.getHeadersList()) # if action fails, validate login try: response = urllib2.urlopen(req) except urllib2.URLError, e: if e.code == 403 or e.code == 401: self.login() req = urllib2.Request(url, None, self.getHeadersList()) try: response = urllib2.urlopen(req) except urllib2.URLError, e: log(str(e), True) return else: log(str(e), True) return response_data = response.read() response.close() for r in re.finditer('placeholder\=\"(Username)\" id\=i\"(nputLoginEmail)\" name\=\"login\"' , response_data, re.DOTALL): loginUsername,loginUsernameName = r.groups() self.login() req = urllib2.Request(url, None, self.getHeadersList()) try: response = urllib2.urlopen(req) except urllib2.URLError, e: log(str(e), True) return response_data = response.read() response.close() # parsing page for videos # video-entry for r in re.finditer('<a id="([^\"]+)" href="([^\"]+)">([^\<]+)</a>' , response_data, re.DOTALL): fileID,url,fileName = r.groups() # streaming videos[fileName] = {'url': 'plugin://plugin.video.cloudstream?mode=streamURL&instance='+self.instanceName+'&url=' + url, 'mediaType' : self.MEDIA_TYPE_VIDEO} for r in re.finditer('<input type="checkbox" name="file_id".*?<a href="([^\"]+)">([^\<]+)</a>' , response_data, re.DOTALL): url,fileName = r.groups() # streaming videos[fileName] = {'url': 'plugin://plugin.video.cloudstream?mode=streamURL&instance='+self.instanceName+'&url=' + url, 'mediaType' : self.MEDIA_TYPE_VIDEO} # video-entry - bestream for r in re.finditer('<TD align=left>[^\<]+<a href="([^\"]+)">([^\<]+)</a>' , response_data, re.DOTALL): url,fileName = r.groups() # streaming videos[fileName] = {'url': 'plugin://plugin.video.cloudstream?mode=streamURL&instance='+self.instanceName+'&url=' + url, 'mediaType' : self.MEDIA_TYPE_VIDEO} # video-entry - uptobox for r in re.finditer('<td style="[^\"]+"><a href="([^\"]+)".*?>([^\<]+)</a></td>' , response_data, re.DOTALL): url,fileName = r.groups() # streaming videos[fileName] = {'url': 'plugin://plugin.video.cloudstream?mode=streamURL&instance='+self.instanceName+'&url=' + url, 'mediaType' : self.MEDIA_TYPE_VIDEO} if 'realvid.net' in self.domain: for r in re.finditer('<a href="[^\"]+">([^\<]+)</a>\s+</TD>' , response_data, re.DOTALL): url,fileName = r.groups() #flatten folders (no clean way of handling subfolders, so just make the root list all folders & subfolders #therefore, skip listing folders if we're not in root # if folderID == 0: # folder-entry # for r in re.finditer('<a href=".*?fld_id=([^\"]+)"><b>([^\<]+)</b></a>' , # folderID = 0 # for r in re.finditer('<option value="(\d\d+)">([^\<]+)</option>' , # response_data, re.DOTALL): # folderID,folderName = r.groups() #remove &nbsp; from folderName # folderName = re.sub('\&nbsp\;', '', folderName) # folder # if int(folderID) != 0: # videos[folderName] = {'url': 'plugin://plugin.video.cloudstream?mode=folder&instance='+self.instanceName+'&folderID=' + folderID, 'mediaType' : self.MEDIA_TYPE_FOLDER} # if folderID == 0: for r in re.finditer('<a href=".*?fld_id=([^\"]+)"><b>([^\<]+)</b></a>' , response_data, re.DOTALL): folderID,folderName = r.groups() # folder if int(folderID) != 0 and folderName != '&nbsp;. .&nbsp;': videos[folderName] = {'url': 'plugin://plugin.video.cloudstream?mode=folder&instance='+self.instanceName+'&folderID=' + folderID, 'mediaType' : self.MEDIA_TYPE_FOLDER} return videos ## # retrieve a video link # parameters: title of video, whether to prompt for quality/format (optional), cache type (optional) # returns: list of URLs for the video or single URL of video (if not prompting for quality) ## def getPublicLink(self,url,cacheType=0): fname = '' opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self.cookiejar)) opener.addheaders = [ ('User-Agent' , self.user_agent)] req = urllib2.Request(url) try: response = opener.open(req) except urllib2.URLError, e: pass response.close() url = response.url # opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self.cookiejar), MyHTTPErrorProcessor) opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self.cookiejar)) opener.addheaders = [ ('User-Agent' , self.user_agent), ('Referer', url), ('Cookie', 'lang=english; login='+self.user+'; xfsts='+self.auth+'; xfss='+self.auth+';')] req = urllib2.Request(url) # if action fails, validate login try: response = opener.open(req) except urllib2.URLError, e: if e.code == 403 or e.code == 401: self.login() req = urllib2.Request(url, None, self.getHeadersList()) try: response = opener.open(req) except urllib2.URLError, e: log(str(e), True) return ('','') else: log(str(e), True) return ('','') response_data = response.read() response.close() for r in re.finditer('\<title\>([^\<]+)\<', response_data, re.DOTALL | re.I): title = r.group(1) if fname == '': fname = title url = response.url req = urllib2.Request(url) for r in re.finditer('name\=\"(code)\" class\=\"(captcha_code)' , response_data, re.DOTALL): loginUsername,loginUsernameName = r.groups() self.login() req = urllib2.Request(url, None, self.getHeadersList()) try: response = urllib2.urlopen(req) except urllib2.URLError, e: log(str(e), True) return ('','') response_data = response.read() response.close() if self.domain == 'vidzi.tv': for r in re.finditer('(file)\: \"([^\"]+)\.mp4\"' ,response_data, re.DOTALL): streamType,streamURL = r.groups() return (streamURL + '.mp4', fname) confirmID = 0 values = {} # fetch video title, download URL and docid for stream link for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="usr_login" value="([^\"]*)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="fname" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">' ,response_data, re.DOTALL): op,usr_login,id,fname,referer = r.groups() values = { 'op' : op, 'usr_login' : usr_login, 'id' : id, 'fname' : fname, 'referer' : referer, 'method_free' : 'Free Download' } for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="usr_login" value="([^\"]*)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="fname" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">.*?<input type="hidden" name="hash" value="([^\"]*)">.*?<input type="submit" name="imhuman" value="([^\"]*)" id="btn_download">' ,response_data, re.DOTALL): op,usr_login,id,fname,referer,hash,submit = r.groups() values = { 'op' : op, 'usr_login' : usr_login, 'id' : id, 'fname' : fname, 'referer' : referer, 'hash' : hash, 'imhuman' : submit } for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="usr_login" value="([^\"]*)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="fname" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">.*?<input type="hidden" name="hash" value="([^\"]*)">.*?<input type="hidden" name="inhu" value="([^\"]*)">.*?<input type="submit" name="imhuman" value="([^\"]*)" id="btn_download">' ,response_data, re.DOTALL): op,usr_login,id,fname,referer,hash,inhu,submit = r.groups() values = { '_vhash' : 'i1102394cE', 'gfk' : 'i22abd2449', 'op' : op, 'usr_login' : usr_login, 'id' : id, 'fname' : fname, 'referer' : referer, 'hash' : hash, 'inhu' : inhu, 'imhuman' : submit } for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="referer" value="([^\"]*)">.*?<input type="hidden" name="method_free" value="([^\"]*)">' ,response_data, re.DOTALL): op,id,referer,submit = r.groups() values = { 'op' : op, 'id' : id, 'referer' : referer, 'method_free' : submit, 'download_direct' : 1 } for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="rand" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">.*?<input type="hidden" name="method_free" value="([^\"]*)">' ,response_data, re.DOTALL): op,id,rand,referer,submit = r.groups() values = { 'op' : op, 'id' : id, 'rand' : rand, 'referer' : referer, 'method_free' : submit, 'download_direct' : 1 } for r in re.finditer('<input type="hidden" name="ipcount_val" id="ipcount_val" value="([^\"]+)">.*?<input type="hidden" name="op" value="([^\"]+)">.*? <input type="hidden" name="usr_login" value="([^\"]*)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="fname" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">' ,response_data, re.DOTALL): ipcount,op,usr_login,id,fname,referer = r.groups() values = { 'ipcount_val' : ipcount, 'op' : op, 'usr_login' : usr_login, 'id' : id, 'fname' : fname, 'referer' : referer, 'method_free' : 'Slow access' } values = {} variable = 'op' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'usr_login' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'id' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'fname' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'referer' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'hash' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'inhu' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'method_free' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'method_premium' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'rand' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'down_direct' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'file_size_real' for r in re.finditer('<input type="(hidden)" name="'+variable+'" value="([^\"]*)">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'imhuman' for r in re.finditer('<input type="(submit)" name="'+variable+'" value="([^\"]*)" id="btn_download">' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = 'gfk' for r in re.finditer('(name): \''+variable+'\', value: \'([^\']*)\'' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value variable = '_vhash' for r in re.finditer('(name): \''+variable+'\', value: \'([^\']*)\'' ,response_data, re.DOTALL): hidden,value = r.groups() values[variable] = value # values['referer'] = '' for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="rand" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">.*?<input type="hidden" name="plugins_are_not_allowed" value="([^\"]+)"/>.*?<input type="hidden" name="method_free" value="([^\"]*)">' ,response_data, re.DOTALL): op,id,rand,referer,plugins,submit = r.groups() values = { 'op' : op, 'id' : id, 'rand' : rand, 'referer' : referer, 'plugins_are_not_allowed' : plugins, 'method_free' : submit, 'download_direct' : 1 } # req = urllib2.Request(url, urllib.urlencode(values), self.getHeadersList(url)) req = urllib2.Request(url) if self.domain == 'thefile.me': values['method_free'] = 'Free Download' elif self.domain == 'sharesix.com': values['method_free'] = 'Free' elif 'streamcloud.eu' in self.domain: xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30037) + str(10)) xbmc.sleep((int(10)+1)*1000) elif self.domain == 'vidhog.com': xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30037) + str(15)) xbmc.sleep((int(15)+1)*1000) elif self.domain == 'vidto.me': xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30037) + str(6)) xbmc.sleep((int(6)+1)*1000) elif self.domain == 'vodlocker.com': xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30037) + str(3)) xbmc.sleep((int(3)+1)*1000) elif self.domain == 'hcbit.com': try: # response = urllib2.urlopen(req) response = opener.open(req, urllib.urlencode(values)) except urllib2.URLError, e: if e.code == 403 or e.code == 401: self.login() try: response = opener.open(req, urllib.urlencode(values)) except urllib2.URLError, e: log(str(e), True) return ('', '') else: log(str(e), True) return ('', '') try: if response.info().getheader('Location') != '': return (response.info().getheader('Location') + '|' + self.getHeadersEncoded(url), fname) except: for r in re.finditer('\'(file)\'\,\'([^\']+)\'' ,response_data, re.DOTALL): streamType,streamURL = r.groups() return (streamURL + '|' + self.getHeadersEncoded(url), fname) for r in re.finditer('\<td (nowrap)\>([^\<]+)\<\/td\>' ,response_data, re.DOTALL): deliminator,fileName = r.groups() for r in re.finditer('(\|)([^\|]{42})\|' ,response_data, re.DOTALL): deliminator,fileID = r.groups() streamURL = 'http://cloud1.hcbit.com/cgi-bin/dl.cgi/'+fileID+'/'+fileName return (streamURL + '|' + self.getHeadersEncoded(url), fname) if self.domain == 'bestreams.net': file_id = '' aff = '' variable = 'file_id' for r in re.finditer('\''+variable+'\', (\')([^\']*)\'' ,response_data, re.DOTALL): hidden,value = r.groups() file_id = value variable = 'aff' for r in re.finditer('\''+variable+'\', (\')([^\']*)\'' ,response_data, re.DOTALL): hidden,value = r.groups() aff = value xbmc.sleep((int(2)+1)*1000) opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self.cookiejar)) opener.addheaders = [ ('User-Agent' , self.user_agent), ('Referer', url), ('Cookie', 'lang=1; file_id='+file_id+'; aff='+aff+';')] elif self.domain == 'thevideo.me': for r in re.finditer('\,\s+\'file\'\s+\:\s+\'([^\']+)\'', response_data, re.DOTALL): streamURL = r.group(1) return (streamURL,fname) elif self.domain == 'vidzi.tv': for r in re.finditer('\s+file:\s+\"([^\"]+)\"', response_data, re.DOTALL): streamURL = r.group(1) return (streamURL,fname) # if action fails, validate login try: # response = urllib2.urlopen(req) response = opener.open(req, urllib.urlencode(values)) except urllib2.URLError, e: if e.code == 403 or e.code == 401: self.login() try: response = opener.open(req, urllib.urlencode(values)) except urllib2.URLError, e: log(str(e), True) return ('','') else: log(str(e), True) return ('','') response_data = response.read() response.close() op='' for r in re.finditer('<input type="hidden" name="op" value="([^\"]+)">.*?<input type="hidden" name="id" value="([^\"]+)">.*?<input type="hidden" name="rand" value="([^\"]*)">.*?<input type="hidden" name="referer" value="([^\"]*)">.*?<input type="hidden" name="method_free" value="([^\"]*)">' ,response_data, re.DOTALL): op,id,rand,referer,submit = r.groups() values = { 'op' : op, 'id' : id, 'rand' : rand, 'referer' : referer, 'method_free' : submit, 'download_direct' : 1 } streamURL='' title = '' for r in re.finditer('\<(title)\>([^\>]*)\<\/title\>' ,response_data, re.DOTALL): titleID,title = r.groups() # for thefile if self.domain == 'thefile.me': downloadAddress = '' for r in re.finditer('\<(img) src\=\"http\:\/\/([^\/]+)\/[^\"]+\" style' ,response_data, re.DOTALL): downloadTag,downloadAddress = r.groups() for r in re.finditer('(\|)([^\|]{56})\|' ,response_data, re.DOTALL): deliminator,fileID = r.groups() streamURL = 'http://'+str(downloadAddress)+'/d/'+fileID+'/video.mp4' elif self.domain == 'sharerepo.com': for r in re.finditer('(file)\: \'([^\']+)\'\,' ,response_data, re.DOTALL): streamType,streamURL = r.groups() for r in re.finditer('(\|)([^\|]{60})\|' ,response_data, re.DOTALL): deliminator,fileID = r.groups() streamURL = 'http://37.48.80.43/d/'+fileID+'/video.mp4?start=0' elif self.domain == 'filenuke.com': for r in re.finditer('(\|)([^\|]{56})\|' ,response_data, re.DOTALL): deliminator,fileID = r.groups() streamURL = 'http://37.252.3.244/d/'+fileID+'/video.flv?start=0' elif self.domain == 'sharerepo.com': for r in re.finditer('(file)\: \'([^\']+)\'\,' ,response_data, re.DOTALL): streamType,streamURL = r.groups() elif self.domain == 'letwatch.us': for r in re.finditer('\[IMG\]http://([^\/]+)\/', response_data, re.DOTALL): IP = r.group(1) for r in re.finditer('\|([^\|]{60})\|', response_data, re.DOTALL): fileID = r.group(1) streamURL = 'http://'+IP+'/'+fileID+'/v.flv' elif self.domain == 'thevideo.me': for r in re.finditer('\,\s+\'file\'\s+\:\s+\'([^\']+)\'', response_data, re.DOTALL): streamURL = r.group(1) elif self.domain == 'vidto.me': for r in re.finditer('var file_link = \'([^\']+)\'', response_data, re.DOTALL): streamURL = r.group(1) elif self.domain == 'allmyvideos.net': for r in re.finditer('\"file\" : \"([^\"]+)\"', response_data, re.DOTALL): streamURL = r.group(1) elif self.domain == 'realvid.net': for r in re.finditer('file:\s?\'([^\']+)\'', response_data, re.DOTALL): streamURL = r.group(1) elif self.domain == 'uptobox.com' or self.domain == 'uptostream.com': for r in re.finditer('\<a href\=\"([^\"]+)\"\>\s+\<span class\=\"button_upload green\"\>', response_data, re.DOTALL): streamURL = r.group(1) return (streamURL, fname) for r in re.finditer('\<source src=\'([^\']+)\'', response_data, re.DOTALL): streamURL = r.group(1) return (streamURL, fname) timeout = 0 if op != "" and streamURL == '': for r in re.finditer('Wait<strong><span id="(.*?)">(\d+)</span> seconds</strong>' ,response_data, re.DOTALL): id,timeout = r.groups() for r in re.finditer('<p class="(err)"><center><b>(.*?)</b>' ,response_data, re.DOTALL): id,error = r.groups() xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), error) return ('','') req = urllib2.Request(url) if timeout > 0: xbmcgui.Dialog().ok(ADDON.getLocalizedString(30000), ADDON.getLocalizedString(30037) + str(timeout)) xbmc.sleep((int(timeout)+1)*1000) # if action fails, validate login try: response = opener.open(req, urllib.urlencode(values)) except urllib2.URLError, e: if e.code == 403 or e.code == 401: self.login() try: response = opener.open(req, urllib.urlencode(values)) except urllib2.URLError, e: log(str(e), True) return ('','') else: log(str(e), True) return ('','') response_data = response.read() response.close() for r in re.finditer('<a href="([^\"]+)">(Click here to start your download)</a>' ,response_data, re.DOTALL): streamURL,downloadlink = r.groups() #vodlocker.com if streamURL == '': # fetch video title, download URL and docid for stream link for r in re.finditer('(file)\: \"([^\"]+)"\,' ,response_data, re.DOTALL): streamType,streamURL = r.groups() if 'mp4' in streamURL: break # mightyupload.com if streamURL == '': # fetch video title, download URL and docid for stream link for r in re.finditer('var (file_link) = \'([^\']+)\'' ,response_data, re.DOTALL): streamType,streamURL = r.groups() # vidhog.com if streamURL == '': # fetch video title, download URL and docid for stream link for r in re.finditer('(product_download_url)=([^\']+)\'' ,response_data, re.DOTALL): streamType,streamURL = r.groups() # vidspot.net if streamURL == '': # fetch video title, download URL and docid for stream link for r in re.finditer('"(file)" : "([^\"]+)"\,' ,response_data, re.DOTALL): streamType,streamURL = r.groups() # uploadc.com if streamURL == '': # fetch video title, download URL and docid for stream link for r in re.finditer('\'(file)\',\'([^\']+)\'\)\;' ,response_data, re.DOTALL): streamType,streamURL = r.groups() streamURL = streamURL + '|' + self.getHeadersEncoded(url) # return 'http://93.120.27.PI:KEY.mp4' return (streamURL, fname) class MyHTTPErrorProcessor(urllib2.HTTPErrorProcessor): def http_response(self, request, response): code, msg, hdrs = response.code, response.msg, response.info() # only add this line to stop 302 redirection. if code == 302: return response if not (200 <= code < 300): response = self.parent.error( 'http', request, response, code, msg, hdrs) return response https_response = http_response

[['URL', "http://cloud1.hcbit.com/cgi-bin/dl.cgi/'+fileID+'/'+fileName"], ['DATE_TIME', '2013-2014'], ['LOCATION', 'xbmcaddon'], ['LOCATION', 'xbmcgui'], ['URL', 'xbmcaddon.Ad'], ['PERSON', 'LOGERROR'], ['PERSON', 'LOGDEBUG'], ['PERSON', 'MEDIA_TYPE_VIDEO'], ['URL', 'urllib2.HT'], ['URL', 'self.co'], ['URL', 'opener.ad'], ['URL', 'self.do'], ['URL', 'self.do'], ['PERSON', 'self.user'], ['URL', 'self.pa'], ['URL', 'e.co'], ['PERSON', 're.finditer'], ['PERSON', 'FireDrive'], ['PERSON', 'Referer'], ['PERSON', 'FireDrive'], ['LOCATION', 'getHeadersEncoded(self'], ['URL', 'self.ge'], ['URL', 'self.do'], ['URL', 'self.do'], ['URL', 'streamcloud.eu'], ['URL', 'urllib2.Re'], ['URL', 'self.ge'], ['URL', 'e.co'], ['URL', 'urllib2.Re'], ['URL', 'self.ge'], ['URL', 'urllib2.Re'], ['URL', 'self.ge'], ['URL', 'r.gr'], ['URL', 'plugin.video.cl'], ['URL', 'self.in'], ['URL', 'self.ME'], ['URL', 'r.gr'], ['URL', 'plugin.video.cl'], ['URL', 'self.in'], ['URL', 'self.ME'], ['URL', 'r.gr'], ['URL', 'plugin.video.cl'], ['URL', 'self.in'], ['URL', 'self.ME'], ['URL', 'r.gr'], ['URL', 'plugin.video.cl'], ['URL', 'self.in'], ['URL', 'self.ME'], ['URL', 'realvid.net'], ['URL', 'r.gr'], ['URL', 'plugin.video.cl'], ['URL', 'self.in'], ['URL', 'self.ME'], ['URL', 'plugin.video.cl'], ['URL', 'self.in'], ['URL', 'self.ME'], ['URL', 'urllib2.HT'], ['URL', 'self.co'], ['URL', 'opener.ad'], ['URL', 'urllib2.Re'], ['URL', 'response.cl'], ['URL', 'urllib2.HT'], ['URL', 'self.co'], ['URL', 'urllib2.HT'], ['URL', 'self.co'], ['URL', 'opener.ad'], ['PERSON', 'Referer'], ['URL', 'self.us'], ['URL', 'urllib2.Re'], ['URL', 'e.co'], ['URL', 'urllib2.Re'], ['URL', 'self.ge'], ['URL', 'urllib2.Re'], ['URL', 're.fi'], ['URL', 'urllib2.Re'], ['URL', 'self.ge'], ['URL', 'r.gr'], ['PERSON', 'fname'], ['URL', 're.fi'], ['LOCATION', 'fname'], ['LOCATION', 'fname'], ['PERSON', 'imhuman'], ['LOCATION', 'fname'], ['PERSON', 'imhuman'], ['LOCATION', 'fname'], ['PERSON', 'inhu'], ['PERSON', 'imhuman'], ['URL', 'urllib2.Re'], ['LOCATION', 'self.getHeadersList(url'], ['URL', 'self.ge'], ['URL', 'urllib2.Re'], ['URL', 'self.do'], ['URL', 'thefile.me'], ['URL', 'e.co'], ['URL', 'self.ge'], ['URL', 're.fi'], ['URL', 'r.gr'], ['URL', 'self.ge'], ['PERSON', 'fname'], ['URL', 're.fi'], ['LOCATION', "re.finditer('(\\|)([^\\|]{42})\\|"], ['URL', 'self.ge'], ['PERSON', 'fname'], ['URL', 'self.do'], ['NRP', 'file_id'], ['LOCATION', "re.finditer('\\''+variable+'\\"], ['NRP', 'file_id'], ['LOCATION', "re.finditer('\\''+variable+'\\"], ['URL', 'urllib2.HT'], ['URL', 'self.co'], ['URL', 'opener.ad'], ['PERSON', 'Referer'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 'e.co'], ['DATE_TIME', "re.finditer('\\<(title)\\>([^\\>]*)\\<\\/title\\"], ['URL', 'video.mp'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 'video.mp'], ['URL', 'self.do'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 'r.gr'], ['URL', 're.fi'], ['PERSON', 'strong><span id="(.*?)">(\\d+)</span> seconds</strong>\''], ['URL', 'urllib2.Re'], ['URL', 'e.co'], ['URL', 'r.gr'], ['URL', 'vodlocker.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'mightyupload.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'vidhog.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'vidspot.net'], ['URL', 're.fi'], ['LOCATION', '^\\"]+)"\\'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'uploadc.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'self.ge'], ['URL', 'KEY.mp'], ['URL', 'urllib2.HT'], ['URL', 'http://www.gnu.org/licenses/'], ['IP_ADDRESS', '37.48.80.43'], ['IP_ADDRESS', '37.252.3.244'], ['URL', 'plugin.video.cl'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'cloudservice.cl'], ['URL', 'self.us'], ['URL', 'self.do'], ['URL', 'uptostream.com'], ['URL', 'self.do'], ['URL', 'uptobox.com'], ['URL', 'self.do'], ['URL', 'self.us'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'self.co'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.us'], ['URL', 'self.us'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.us'], ['URL', 'self.us'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'self.us'], ['URL', 'self.do'], ['URL', 'self.do'], ['URL', 'e.co'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'self.do'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.fi'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.su'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'self.us'], ['URL', 'self.us'], ['URL', 'self.au'], ['URL', 'self.au'], ['URL', 'e.co'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 'self.do'], ['URL', 'vidzi.tv'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'sharesix.com'], ['URL', 'streamcloud.eu'], ['URL', 'self.do'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'xbmc.sl'], ['URL', 'self.do'], ['URL', 'vidhog.com'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'xbmc.sl'], ['URL', 'self.do'], ['URL', 'vidto.me'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'xbmc.sl'], ['URL', 'self.do'], ['URL', 'vodlocker.com'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'xbmc.sl'], ['URL', 'self.do'], ['URL', 'hcbit.com'], ['URL', 'e.co'], ['URL', 'response.in'], ['URL', 'response.in'], ['URL', 're.DO'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'bestreams.net'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'xbmc.sl'], ['URL', 'self.us'], ['URL', 'self.do'], ['URL', 'thevideo.me'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'vidzi.tv'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'e.co'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'self.do'], ['URL', 'thefile.me'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'sharerepo.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'filenuke.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'sharerepo.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'letwatch.us'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'thevideo.me'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'vidto.me'], ['URL', 're.fi'], ['URL', 'allmyvideos.net'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'realvid.net'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'uptobox.com'], ['URL', 'self.do'], ['URL', 'uptostream.com'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 're.DO'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'r.gr'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'ADDON.ge'], ['URL', 'xbmc.sl'], ['URL', 'e.co'], ['URL', 'response.re'], ['URL', 'response.cl'], ['URL', 're.fi'], ['URL', 're.DO'], ['URL', 'response.co'], ['URL', 'response.ms'], ['URL', 'response.in'], ['URL', 'self.parent.er']]

# Version: 0.15+dev """The Versioneer - like a rocketeer, but for versions. The Versioneer ============== * like a rocketeer, but for versions! * https://github.com/warner/python-versioneer * Brian Warner * License: Public Domain * Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, and pypy * [![Latest Version] (https://pypip.in/version/versioneer/badge.svg?style=flat) ](https://pypi.python.org/pypi/versioneer/) * [![Build Status] (https://travis-ci.org/warner/python-versioneer.png?branch=master) ](https://travis-ci.org/warner/python-versioneer) This is a tool for managing a recorded version number in distutils-based python projects. The goal is to remove the tedious and error-prone "update the embedded version string" step from your release process. Making a new release should be as easy as recording a new tag in your version-control system, and maybe making new tarballs. ## Quick Install * `pip install versioneer` to somewhere to your $PATH * add a `[versioneer]` section to your setup.cfg (see below) * run `versioneer install` in your source tree, commit the results ## Version Identifiers Source trees come from a variety of places: * a version-control system checkout (mostly used by developers) * a nightly tarball, produced by build automation * a snapshot tarball, produced by a web-based VCS browser, like github's "tarball from tag" feature * a release tarball, produced by "setup.py sdist", distributed through PyPI Within each source tree, the version identifier (either a string or a number, this tool is format-agnostic) can come from a variety of places: * ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows about recent "tags" and an absolute revision-id * the name of the directory into which the tarball was unpacked * an expanded VCS keyword ($Id$, etc) * a `_version.py` created by some earlier build step For released software, the version identifier is closely related to a VCS tag. Some projects use tag names that include more than just the version string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool needs to strip the tag prefix to extract the version identifier. For unreleased software (between tags), the version identifier should provide enough information to help developers recreate the same tree, while also giving them an idea of roughly how old the tree is (after version 1.2, before version 1.3). Many VCS systems can report a description that captures this, for example `git describe --tags --dirty --always` reports things like "0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the 0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has uncommitted changes. The version identifier is used for multiple purposes: * to allow the module to self-identify its version: `myproject.__version__` * to choose a name and prefix for a 'setup.py sdist' tarball ## Theory of Operation Versioneer works by adding a special `_version.py` file into your source tree, where your `__init__.py` can import it. This `_version.py` knows how to dynamically ask the VCS tool for version information at import time. `_version.py` also contains `$Revision$` markers, and the installation process marks `_version.py` to have this marker rewritten with a tag name during the `git archive` command. As a result, generated tarballs will contain enough information to get the proper version. To allow `setup.py` to compute a version too, a `versioneer.py` is added to the top level of your source tree, next to `setup.py` and the `setup.cfg` that configures it. This overrides several distutils/setuptools commands to compute the version when invoked, and changes `setup.py build` and `setup.py sdist` to replace `_version.py` with a small static file that contains just the generated version data. ## Installation First, decide on values for the following configuration variables: * `VCS`: the version control system you use. Currently accepts "git". * `style`: the style of version string to be produced. See "Styles" below for details. Defaults to "pep440", which looks like `TAG[+DISTANCE.gSHORTHASH[.dirty]]`. * `versionfile_source`: A project-relative pathname into which the generated version strings should be written. This is usually a `_version.py` next to your project's main `__init__.py` file, so it can be imported at runtime. If your project uses `src/myproject/__init__.py`, this should be `src/myproject/_version.py`. This file should be checked in to your VCS as usual: the copy created below by `setup.py setup_versioneer` will include code that parses expanded VCS keywords in generated tarballs. The 'build' and 'sdist' commands will replace it with a copy that has just the calculated version string. This must be set even if your project does not have any modules (and will therefore never import `_version.py`), since "setup.py sdist" -based trees still need somewhere to record the pre-calculated version strings. Anywhere in the source tree should do. If there is a `__init__.py` next to your `_version.py`, the `setup.py setup_versioneer` command (described below) will append some `__version__`-setting assignments, if they aren't already present. * `versionfile_build`: Like `versionfile_source`, but relative to the build directory instead of the source directory. These will differ when your setup.py uses 'package_dir='. If you have `package_dir={'myproject': 'src/myproject'}`, then you will probably have `versionfile_build='myproject/_version.py'` and `versionfile_source='src/myproject/_version.py'`. If this is set to None, then `setup.py build` will not attempt to rewrite any `_version.py` in the built tree. If your project does not have any libraries (e.g. if it only builds a script), then you should use `versionfile_build = None`. To actually use the computed version string, your `setup.py` will need to override `distutils.command.build_scripts` with a subclass that explicitly inserts a copy of `versioneer.get_version()` into your script file. See `test/demoapp-script-only/setup.py` for an example. * `tag_prefix`: a string, like 'PROJECTNAME-', which appears at the start of all VCS tags. If your tags look like 'myproject-1.2.0', then you should use tag_prefix='myproject-'. If you use unprefixed tags like '1.2.0', this should be an empty string, using either `tag_prefix=` or `tag_prefix=''`. * `parentdir_prefix`: a optional string, frequently the same as tag_prefix, which appears at the start of all unpacked tarball filenames. If your tarball unpacks into 'myproject-1.2.0', this should be 'myproject-'. To disable this feature, just omit the field from your `setup.cfg`. This tool provides one script, named `versioneer`. That script has one mode, "install", which writes a copy of `versioneer.py` into the current directory and runs `versioneer.py setup` to finish the installation. To versioneer-enable your project: * 1: Modify your `setup.cfg`, adding a section named `[versioneer]` and populating it with the configuration values you decided earlier (note that the option names are not case-sensitive): ```` [versioneer] VCS = git style = pep440 versionfile_source = src/myproject/_version.py versionfile_build = myproject/_version.py tag_prefix = parentdir_prefix = myproject- ```` * 2: Run `versioneer install`. This will do the following: * copy `versioneer.py` into the top of your source tree * create `_version.py` in the right place (`versionfile_source`) * modify your `__init__.py` (if one exists next to `_version.py`) to define `__version__` (by calling a function from `_version.py`) * modify your `MANIFEST.in` to include both `versioneer.py` and the generated `_version.py` in sdist tarballs `versioneer install` will complain about any problems it finds with your `setup.py` or `setup.cfg`. Run it multiple times until you have fixed all the problems. * 3: add a `import versioneer` to your setup.py, and add the following arguments to the setup() call: version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), * 4: commit these changes to your VCS. To make sure you won't forget, `versioneer install` will mark everything it touched for addition using `git add`. Don't forget to add `setup.py` and `setup.cfg` too. ## Post-Installation Usage Once established, all uses of your tree from a VCS checkout should get the current version string. All generated tarballs should include an embedded version string (so users who unpack them will not need a VCS tool installed). If you distribute your project through PyPI, then the release process should boil down to two steps: * 1: git tag 1.0 * 2: python setup.py register sdist upload If you distribute it through github (i.e. users use github to generate tarballs with `git archive`), the process is: * 1: git tag 1.0 * 2: git push; git push --tags Versioneer will report "0+untagged.NUMCOMMITS.gHASH" until your tree has at least one tag in its history. ## Version-String Flavors Code which uses Versioneer can learn about its version string at runtime by importing `_version` from your main `__init__.py` file and running the `get_versions()` function. From the "outside" (e.g. in `setup.py`), you can import the top-level `versioneer.py` and run `get_versions()`. Both functions return a dictionary with different flavors of version information: * `['version']`: A condensed version string, rendered using the selected style. This is the most commonly used value for the project's version string. The default "pep440" style yields strings like `0.11`, `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section below for alternative styles. * `['full-revisionid']`: detailed revision identifier. For Git, this is the full SHA1 commit id, e.g. "PI:KEY". * `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that this is only accurate if run in a VCS checkout, otherwise it is likely to be False or None * `['error']`: if the version string could not be computed, this will be set to a string describing the problem, otherwise it will be None. It may be useful to throw an exception in setup.py if this is set, to avoid e.g. creating tarballs with a version string of "unknown". Some variants are more useful than others. Including `full-revisionid` in a bug report should allow developers to reconstruct the exact code being tested (or indicate the presence of local changes that should be shared with the developers). `version` is suitable for display in an "about" box or a CLI `--version` output: it can be easily compared against release notes and lists of bugs fixed in various releases. The installer adds the following text to your `__init__.py` to place a basic version in `YOURPROJECT.__version__`: from ._version import get_versions __version__ = get_versions()['version'] del get_versions ## Styles The setup.cfg `style=` configuration controls how the VCS information is rendered into a version string. The default style, "pep440", produces a PEP440-compliant string, equal to the un-prefixed tag name for actual releases, and containing an additional "local version" section with more detail for in-between builds. For Git, this is TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags --dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and that this commit is two revisions ("+2") beyond the "0.11" tag. For released software (exactly equal to a known tag), the identifier will only contain the stripped tag, e.g. "0.11". Other styles are available. See details.md in the Versioneer source tree for descriptions. ## Debugging Versioneer tries to avoid fatal errors: if something goes wrong, it will tend to return a version of "0+unknown". To investigate the problem, run `setup.py version`, which will run the version-lookup code in a verbose mode, and will display the full contents of `get_versions()` (including the `error` string, which may help identify what went wrong). ## Updating Versioneer To upgrade your project to a new release of Versioneer, do the following: * install the new Versioneer (`pip install -U versioneer` or equivalent) * edit `setup.cfg`, if necessary, to include any new configuration settings indicated by the release notes * re-run `versioneer install` in your source tree, to replace `SRC/_version.py` * commit any changed files ### Upgrading to 0.15 Starting with this version, Versioneer is configured with a `[versioneer]` section in your `setup.cfg` file. Earlier versions required the `setup.py` to set attributes on the `versioneer` module immediately after import. The new version will refuse to run (raising an exception during import) until you have provided the necessary `setup.cfg` section. In addition, the Versioneer package provides an executable named `versioneer`, and the installation process is driven by running `versioneer install`. In 0.14 and earlier, the executable was named `versioneer-installer` and was run without an argument. ### Upgrading to 0.14 0.14 changes the format of the version string. 0.13 and earlier used hyphen-separated strings like "0.11-2-g1076c97-dirty". 0.14 and beyond use a plus-separated "local version" section strings, with dot-separated components, like "0.11+2.g1076c97". PEP440-strict tools did not like the old format, but should be ok with the new one. ### Upgrading from 0.11 to 0.12 Nothing special. ### Upgrading from 0.10 to 0.11 You must add a `versioneer.VCS = "git"` to your `setup.py` before re-running `setup.py setup_versioneer`. This will enable the use of additional version-control systems (SVN, etc) in the future. ## Future Directions This tool is designed to make it easily extended to other version-control systems: all VCS-specific components are in separate directories like src/git/ . The top-level `versioneer.py` script is assembled from these components by running make-versioneer.py . In the future, make-versioneer.py will take a VCS name as an argument, and will construct a version of `versioneer.py` that is specific to the given VCS. It might also take the configuration arguments that are currently provided manually during installation by editing setup.py . Alternatively, it might go the other direction and include code from all supported VCS systems, reducing the number of intermediate scripts. ## License To make Versioneer easier to embed, all its code is dedicated to the public domain. The `_version.py` that it creates is also in the public domain. Specifically, both are released under the Creative Commons "Public Domain Dedication" license (CC0-1.0), as described in https://creativecommons.org/publicdomain/zero/1.0/ . """ from __future__ import print_function try: import configparser except ImportError: import ConfigParser as configparser import errno import json import os import re import subprocess import sys class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_root(): """Get the project root directory. We require that all commands are run from the project root, i.e. the directory that contains setup.py, setup.cfg, and versioneer.py . """ root = os.path.realpath(os.path.abspath(os.getcwd())) setup_py = os.path.join(root, "setup.py") versioneer_py = os.path.join(root, "versioneer.py") if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): # allow 'python path/to/setup.py COMMAND' root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) setup_py = os.path.join(root, "setup.py") versioneer_py = os.path.join(root, "versioneer.py") if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): err = ("Versioneer was unable to run the project root directory. " "Versioneer requires setup.py to be executed from " "its immediate directory (like 'python setup.py COMMAND'), " "or in a way that lets it use sys.argv[0] to find the root " "(like 'python path/to/setup.py COMMAND').") raise VersioneerBadRootError(err) try: # Certain runtime workflows (setup.py install/develop in a setuptools # tree) execute all dependencies in a single python process, so # "versioneer" may be imported multiple times, and python's shared # module-import table will cache the first one. So we can't use # os.path.dirname(__file__), as that will find whichever # versioneer.py was first imported, even in later projects. me = os.path.realpath(os.path.abspath(__file__)) if os.path.splitext(me)[0] != os.path.splitext(versioneer_py)[0]: print("Warning: build in %s is using versioneer.py from %s" % (os.path.dirname(me), versioneer_py)) except NameError: pass return root def get_config_from_root(root): """Read the project setup.cfg file to determine Versioneer config.""" # This might raise EnvironmentError (if setup.cfg is missing), or # configparser.NoSectionError (if it lacks a [versioneer] section), or # configparser.NoOptionError (if it lacks "VCS="). See the docstring at # the top of versioneer.py for instructions on writing your setup.cfg . setup_cfg = os.path.join(root, "setup.cfg") parser = configparser.SafeConfigParser() with open(setup_cfg, "r") as f: parser.readfp(f) VCS = parser.get("versioneer", "VCS") # mandatory def get(parser, name): if parser.has_option("versioneer", name): return parser.get("versioneer", name) return None cfg = VersioneerConfig() cfg.VCS = VCS cfg.style = get(parser, "style") or "" cfg.versionfile_source = get(parser, "versionfile_source") cfg.versionfile_build = get(parser, "versionfile_build") cfg.tag_prefix = get(parser, "tag_prefix") if cfg.tag_prefix in ("''", '""'): cfg.tag_prefix = "" cfg.parentdir_prefix = get(parser, "parentdir_prefix") cfg.verbose = get(parser, "verbose") return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" # these dictionaries contain VCS-specific tools LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %s" % dispcmd) print(e) return None else: if verbose: print("unable to find command, tried %s" % (commands,)) return None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) return None return stdout LONG_VERSION_PY['git'] = r''' # This file helps to compute a version number in source trees obtained from # git-archive tarball (such as those provided by githubs download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. # This file is released into the public domain. Generated by # versioneer-0.15+dev (https://github.com/warner/python-versioneer) """Git implementation of _version.py.""" import errno import os import re import subprocess import sys def get_keywords(): """Get the keywords needed to look up the version information.""" # these strings will be replaced by git during git-archive. # setup.py/versioneer.py will grep for the variable names, so they must # each be defined on a line of their own. _version.py will just call # get_keywords(). git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" keywords = {"refnames": git_refnames, "full": git_full} return keywords class VersioneerConfig: """Container for Versioneer configuration parameters.""" def get_config(): """Create, populate and return the VersioneerConfig() object.""" # these strings are filled in when 'setup.py versioneer' creates # _version.py cfg = VersioneerConfig() cfg.VCS = "git" cfg.style = "%(STYLE)s" cfg.tag_prefix = "%(TAG_PREFIX)s" cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" cfg.verbose = False return cfg class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" LONG_VERSION_PY = {} HANDLERS = {} def register_vcs_handler(vcs, method): # decorator """Decorator to mark a method as the handler for a particular VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} HANDLERS[vcs][method] = f return f return decorate def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): """Call the given command(s).""" assert isinstance(commands, list) p = None for c in commands: try: dispcmd = str([c] + args) # remember shell=False, so use git.cmd on windows, not just git p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None)) break except EnvironmentError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue if verbose: print("unable to run %%s" %% dispcmd) print(e) return None else: if verbose: print("unable to find command, tried %%s" %% (commands,)) return None stdout = p.communicate()[0].strip() if sys.version_info[0] >= 3: stdout = stdout.decode() if p.returncode != 0: if verbose: print("unable to run %%s (error)" %% dispcmd) return None return stdout def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. """ dirname = os.path.basename(root) if not dirname.startswith(parentdir_prefix): if verbose: print("guessing rootdir is '%%s', but '%%s' doesn't start with " "prefix '%%s'" %% (root, dirname, parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None} @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = [r.strip() for r in refnames.strip("()").split(",")] # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %%d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%%s', no digits" %% ",".join(set(refs) - tags)) if verbose: print("likely tags: %%s" %% ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %%s" %% r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None, "branch": None } # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags", "branch": None} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ if not os.path.exists(os.path.join(root, ".git")): if verbose: print("no .git in %%s" %% root) raise NotThisMethod("no .git directory") GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM). Note, for git v1.7 # and below, it is necessary to run "git update-index --refresh" first. describe_out = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%%s*" %% tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # abbrev-ref available with git >= 1.7 branch_name = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], cwd=root).strip() if branch_name == 'HEAD': branches = run_command(GITS, ["branch", "--contains"], cwd=root).split('\n') branches = [branch[2:] for branch in branches if branch[4:5] != '('] if 'master' in branches: branch_name = 'master' elif not branches: branch_name = None else: # Pick the first branch that is returned. Good or bad. branch_name = branches[0] pieces['branch'] = branch_name # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%%s'" %% describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%%s' doesn't start with prefix '%%s'" print(fmt %% (full_tag, tag_prefix)) pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" %% (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits return pieces # Default matches v1.2.x, maint/1.2.x, 1.2.x, 1.x etc. default_maint_branch_regexp = ".*([0-9]+\.)+x$" def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%%d" %% pieces["distance"] else: # exception #1 rendered = "0.post.dev%%d" %% pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%%s" %% pieces["short"] else: # exception #1 rendered = "0.post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%%s" %% pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%%d" %% pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def add_one_to_version(version_string, number_index_to_increment=-1): """ Add one to a version string at the given numeric indices. >>> add_one_to_version('v1.2.3') 'v1.2.4' """ # Break up the tag by number groups (preserving multi-digit # numbers as multidigit) parts = re.split("([0-9]+)", version_string) digit_parts = [(i, part) for i, part in enumerate(parts) if part.isdigit()] # Deal with negative indexing. increment_at_index = ((number_index_to_increment + len(digit_parts)) %% len(digit_parts)) for n_seen, (i, part) in enumerate(digit_parts): if n_seen == increment_at_index: parts[i] = str(int(part) + 1) elif n_seen > increment_at_index: parts[i] = '0' return ''.join(parts) def render_pep440_branch_based(pieces): # [TAG+1 of minor number][.devDISTANCE][+gHEX]. The git short is # included for dirty. # exceptions: # 1: no tags. 0.0.0.devDISTANCE[+gHEX] replacements = {' ': '.', '(': '', ')': ''} [branch_name] = [pieces.get('branch').replace(old, new) for old, new in replacements.items()] master = branch_name == 'master' maint = re.match(default_maint_branch_regexp, branch_name or '') # If we are on a tag, just pep440-pre it. if pieces["closest-tag"] and not (pieces["distance"] or pieces["dirty"]): rendered = pieces["closest-tag"] else: # Put a default closest-tag in. if not pieces["closest-tag"]: pieces["closest-tag"] = '0.0.0' if pieces["distance"] or pieces["dirty"]: if maint: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post%%d" %% pieces["distance"] else: rendered = add_one_to_version(pieces["closest-tag"]) if pieces["distance"]: rendered += ".dev%%d" %% pieces["distance"] suffix = [] # Put the branch name in if it isn't master nor a # maintenance branch. if not (master or maint): suffix.append('%%s' %% (branch_name or 'unknown_branch')) if pieces["dirty"]: suffix.append('g%%s' %% pieces["short"]) rendered += '+%%s' %% ''.join(suffix) else: rendered = pieces["closest-tag"] return rendered STYLES = {'default': render_pep440, 'pep440': render_pep440, 'pep440-pre': render_pep440_pre, 'pep440-post': render_pep440_post, 'pep440-old': render_pep440_old, 'git-describe': render_git_describe, 'git-describe-long': render_git_describe_long, 'pep440-old': render_pep440_old, 'pep440-branch-based': render_pep440_branch_based, } def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"]} if not style: style = 'default' renderer = STYLES.get(style) if not renderer: raise ValueError("unknown style '%%s'" %% style) rendered = renderer(pieces) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None} def get_versions(): """Get version information or return default if unable to do so.""" # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have # __file__, we can work backwards from there to the root. Some # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which # case we can only use expanded keywords. cfg = get_config() verbose = cfg.verbose try: return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, verbose) except NotThisMethod: pass try: root = os.path.realpath(__file__) # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. for i in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to find root of source tree"} try: pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) return render(pieces, cfg.style) except NotThisMethod: pass try: if cfg.parentdir_prefix: return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) except NotThisMethod: pass return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version"} ''' @register_vcs_handler("git", "get_keywords") def git_get_keywords(versionfile_abs): """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. keywords = {} try: f = open(versionfile_abs, "r") for line in f.readlines(): if line.strip().startswith("git_refnames ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["refnames"] = mo.group(1) if line.strip().startswith("git_full ="): mo = re.search(r'=\s*"(.*)"', line) if mo: keywords["full"] = mo.group(1) f.close() except EnvironmentError: pass return keywords @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" if not keywords: raise NotThisMethod("no keywords at all, weird") refnames = keywords["refnames"].strip() if refnames.startswith("$Format"): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") refs = [r.strip() for r in refnames.strip("()").split(",")] # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d # expansion behaves like git log --decorate=short and strips out the # refs/heads/ and refs/tags/ prefixes that would let us distinguish # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". tags = set([r for r in refs if re.search(r'\d', r)]) if verbose: print("discarding '%s', no digits" % ",".join(set(refs) - tags)) if verbose: print("likely tags: %s" % ",".join(sorted(tags))) for ref in sorted(tags): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] if verbose: print("picking %s" % r) return {"version": r, "full-revisionid": keywords["full"].strip(), "dirty": False, "error": None, "branch": None } # no suitable tags, so version is "0+unknown", but full hex is still there if verbose: print("no suitable tags, using unknown + full revision id") return {"version": "0+unknown", "full-revisionid": keywords["full"].strip(), "dirty": False, "error": "no suitable tags", "branch": None} @register_vcs_handler("git", "pieces_from_vcs") def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* expanded, and _version.py hasn't already been rewritten with a short version string, meaning we're inside a checked out source tree. """ if not os.path.exists(os.path.join(root, ".git")): if verbose: print("no .git in %s" % root) raise NotThisMethod("no .git directory") GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM). Note, for git v1.7 # and below, it is necessary to run "git update-index --refresh" first. describe_out = run_command(GITS, ["describe", "--tags", "--dirty", "--always", "--long", "--match", "%s*" % tag_prefix], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() pieces = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None # abbrev-ref available with git >= 1.7 branch_name = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], cwd=root).strip() if branch_name == 'HEAD': branches = run_command(GITS, ["branch", "--contains"], cwd=root).split('\n') branches = [branch[2:] for branch in branches if branch[4:5] != '('] if 'master' in branches: branch_name = 'master' elif not branches: branch_name = None else: # Pick the first branch that is returned. Good or bad. branch_name = branches[0] pieces['branch'] = branch_name # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out # look for -dirty suffix dirty = git_describe.endswith("-dirty") pieces["dirty"] = dirty if dirty: git_describe = git_describe[:git_describe.rindex("-dirty")] # now we have TAG-NUM-gHEX or HEX if "-" in git_describe: # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: # unparseable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces # tag full_tag = mo.group(1) if not full_tag.startswith(tag_prefix): if verbose: fmt = "tag '%s' doesn't start with prefix '%s'" print(fmt % (full_tag, tag_prefix)) pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" % (full_tag, tag_prefix)) return pieces pieces["closest-tag"] = full_tag[len(tag_prefix):] # distance: number of commits since tag pieces["distance"] = int(mo.group(2)) # commit: short hex revision ID pieces["short"] = mo.group(3) else: # HEX: no tags pieces["closest-tag"] = None count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits return pieces def do_vcs_install(manifest_in, versionfile_source, ipy): """Git-specific installation logic for Versioneer. For Git, this means creating/changing .gitattributes to mark _version.py for export-time keyword substitution. """ GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] files = [manifest_in, versionfile_source] if ipy: files.append(ipy) try: me = __file__ if me.endswith(".pyc") or me.endswith(".pyo"): me = os.path.splitext(me)[0] + ".py" versioneer_file = os.path.relpath(me) except NameError: versioneer_file = "versioneer.py" files.append(versioneer_file) present = False try: f = open(".gitattributes", "r") for line in f.readlines(): if line.strip().startswith(versionfile_source): if "export-subst" in line.strip().split()[1:]: present = True f.close() except EnvironmentError: pass if not present: f = open(".gitattributes", "a+") f.write("%s export-subst\n" % versionfile_source) f.close() files.append(".gitattributes") run_command(GITS, ["add", "--"] + files) def versions_from_parentdir(parentdir_prefix, root, verbose): """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both the project name and a version string. """ dirname = os.path.basename(root) if not dirname.startswith(parentdir_prefix): if verbose: print("guessing rootdir is '%s', but '%s' doesn't start with " "prefix '%s'" % (root, dirname, parentdir_prefix)) raise NotThisMethod("rootdir doesn't start with parentdir_prefix") return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None} SHORT_VERSION_PY = """ # This file was generated by 'versioneer.py' (0.15+dev) from # revision-control system data, or from the parent directory name of an # unpacked source archive. Distribution tarballs contain a pre-generated copy # of this file. import json import sys version_json = ''' %s ''' # END VERSION_JSON def get_versions(): return json.loads(version_json) """ def versions_from_file(filename): """Try to determine the version from _version.py if present.""" try: with open(filename) as f: contents = f.read() except EnvironmentError: raise NotThisMethod("unable to read _version.py") mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", contents, re.M | re.S) if not mo: raise NotThisMethod("no version_json in _version.py") return json.loads(mo.group(1)) def write_to_version_file(filename, versions): """Write the given version number to the given _version.py file.""" os.unlink(filename) contents = json.dumps(versions, sort_keys=True, indent=1, separators=(",", ": ")) with open(filename, "w") as f: f.write(SHORT_VERSION_PY % contents) print("set %s to '%s'" % (filename, versions["version"])) # Default matches v1.2.x, maint/1.2.x, 1.2.x, 1.x etc. default_maint_branch_regexp = ".*([0-9]+\.)+x$" def plus_or_dot(pieces): """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" def render_pep440(pieces): """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += plus_or_dot(pieces) rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" else: # exception #1 rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) if pieces["dirty"]: rendered += ".dirty" return rendered def render_pep440_pre(pieces): """TAG[.post.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post.devDISTANCE """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post.dev%d" % pieces["distance"] else: # exception #1 rendered = "0.post.dev%d" % pieces["distance"] return rendered def render_pep440_post(pieces): """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards (a dirty tree will appear "older" than the corresponding clean one), but you shouldn't be releasing software with -dirty anyways. Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += plus_or_dot(pieces) rendered += "g%s" % pieces["short"] else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" rendered += "+g%s" % pieces["short"] return rendered def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. Eexceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"] or pieces["dirty"]: rendered += ".post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" else: # exception #1 rendered = "0.post%d" % pieces["distance"] if pieces["dirty"]: rendered += ".dev0" return rendered def render_git_describe(pieces): """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def render_git_describe_long(pieces): """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. The distance/hash is unconditional. Exceptions: 1: no tags. HEX[-dirty] (note: no 'g' prefix) """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) else: # exception #1 rendered = pieces["short"] if pieces["dirty"]: rendered += "-dirty" return rendered def add_one_to_version(version_string, number_index_to_increment=-1): """ Add one to a version string at the given numeric indices. >>> add_one_to_version('v1.2.3') 'v1.2.4' """ # Break up the tag by number groups (preserving multi-digit # numbers as multidigit) parts = re.split("([0-9]+)", version_string) digit_parts = [(i, part) for i, part in enumerate(parts) if part.isdigit()] # Deal with negative indexing. increment_at_index = ((number_index_to_increment + len(digit_parts)) % len(digit_parts)) for n_seen, (i, part) in enumerate(digit_parts): if n_seen == increment_at_index: parts[i] = str(int(part) + 1) elif n_seen > increment_at_index: parts[i] = '0' return ''.join(parts) def render_pep440_branch_based(pieces): # [TAG+1 of minor number][.devDISTANCE][+gHEX]. The git short is # included for dirty. # exceptions: # 1: no tags. 0.0.0.devDISTANCE[+gHEX] replacements = {' ': '.', '(': '', ')': ''} branch_name = pieces.get('branch') for old, new in replacements.items(): branch_name = branch_name.replace(old, new) master = branch_name == 'master' maint = re.match(default_maint_branch_regexp, branch_name or '') # If we are on a tag, just pep440-pre it. if pieces["closest-tag"] and not (pieces["distance"] or pieces["dirty"]): rendered = pieces["closest-tag"] else: # Put a default closest-tag in. if not pieces["closest-tag"]: pieces["closest-tag"] = '0.0.0' if pieces["distance"] or pieces["dirty"]: if maint: rendered = pieces["closest-tag"] if pieces["distance"]: rendered += ".post%d" % pieces["distance"] else: rendered = add_one_to_version(pieces["closest-tag"]) if pieces["distance"]: rendered += ".dev%d" % pieces["distance"] suffix = [] # Put the branch name in if it isn't master nor a # maintenance branch. if not (master or maint): suffix.append('%s' % (branch_name or 'unknown_branch')) if pieces["dirty"]: suffix.append('g%s' % pieces["short"]) rendered += '+%s' % ''.join(suffix) else: rendered = pieces["closest-tag"] return rendered STYLES = {'default': render_pep440, 'pep440': render_pep440, 'pep440-pre': render_pep440_pre, 'pep440-post': render_pep440_post, 'pep440-old': render_pep440_old, 'git-describe': render_git_describe, 'git-describe-long': render_git_describe_long, 'pep440-old': render_pep440_old, 'pep440-branch-based': render_pep440_branch_based, } def render(pieces, style): """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", "full-revisionid": pieces.get("long"), "dirty": None, "error": pieces["error"]} if not style: style = 'default' renderer = STYLES.get(style) if not renderer: raise ValueError("unknown style '%s'" % style) rendered = renderer(pieces) return {"version": rendered, "full-revisionid": pieces["long"], "dirty": pieces["dirty"], "error": None} class VersioneerBadRootError(Exception): """The project root directory is unknown or missing key files.""" def get_versions(verbose=False): """Get the project version from whatever source is available. Returns dict with two keys: 'version' and 'full'. """ if "versioneer" in sys.modules: # see the discussion in cmdclass.py:get_cmdclass() del sys.modules["versioneer"] root = get_root() cfg = get_config_from_root(root) assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" handlers = HANDLERS.get(cfg.VCS) assert handlers, "unrecognized VCS '%s'" % cfg.VCS verbose = verbose or cfg.verbose assert cfg.versionfile_source is not None, \ "please set versioneer.versionfile_source" assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" versionfile_abs = os.path.join(root, cfg.versionfile_source) # extract version from first of: _version.py, VCS command (e.g. 'git # describe'), parentdir. This is meant to work for developers using a # source checkout, for users of a tarball created by 'setup.py sdist', # and for users of a tarball/zipball created by 'git archive' or github's # download-from-tag feature or the equivalent in other VCSes. get_keywords_f = handlers.get("get_keywords") from_keywords_f = handlers.get("keywords") if get_keywords_f and from_keywords_f: try: keywords = get_keywords_f(versionfile_abs) ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) if verbose: print("got version from expanded keyword %s" % ver) return ver except NotThisMethod: pass try: ver = versions_from_file(versionfile_abs) if verbose: print("got version from file %s %s" % (versionfile_abs, ver)) return ver except NotThisMethod: pass from_vcs_f = handlers.get("pieces_from_vcs") if from_vcs_f: try: pieces = from_vcs_f(cfg.tag_prefix, root, verbose) ver = render(pieces, cfg.style) if verbose: print("got version from VCS %s" % ver) return ver except NotThisMethod: pass try: if cfg.parentdir_prefix: ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) if verbose: print("got version from parentdir %s" % ver) return ver except NotThisMethod: pass if verbose: print("unable to compute version") return {"version": "0+unknown", "full-revisionid": None, "dirty": None, "error": "unable to compute version"} def get_version(): """Get the short version string for this project.""" return get_versions()["version"] def get_cmdclass(): """Get the custom setuptools/distutils subclasses used by Versioneer.""" if "versioneer" in sys.modules: del sys.modules["versioneer"] # this fixes the "python setup.py develop" case (also 'install' and # 'easy_install .'), in which subdependencies of the main project are # built (using setup.py bdist_egg) in the same python process. Assume # a main project A and a dependency B, which use different versions # of Versioneer. A's setup.py imports A's Versioneer, leaving it in # sys.modules by the time B's setup.py is executed, causing B to run # with the wrong versioneer. Setuptools wraps the sub-dep builds in a # sandbox that restores sys.modules to it's pre-build state, so the # parent is protected against the child's "import versioneer". By # removing ourselves from sys.modules here, before the child build # happens, we protect the child from the parent's versioneer too. # Also see https://github.com/warner/python-versioneer/issues/52 cmds = {} # we add "version" to both distutils and setuptools from distutils.core import Command class cmd_version(Command): description = "report generated version string" user_options = [] boolean_options = [] def initialize_options(self): pass def finalize_options(self): pass def run(self): vers = get_versions(verbose=True) print("Version: %s" % vers["version"]) print(" full-revisionid: %s" % vers.get("full-revisionid")) print(" dirty: %s" % vers.get("dirty")) if vers["error"]: print(" error: %s" % vers["error"]) cmds["version"] = cmd_version # we override "build_py" in both distutils and setuptools # # most invocation pathways end up running build_py: # distutils/build -> build_py # distutils/install -> distutils/build ->.. # setuptools/bdist_wheel -> distutils/install ->.. # setuptools/bdist_egg -> distutils/install_lib -> build_py # setuptools/install -> bdist_egg ->.. # setuptools/develop -> ? # we override different "build_py" commands for both environments if "setuptools" in sys.modules: from setuptools.command.build_py import build_py as _build_py else: from distutils.command.build_py import build_py as _build_py class cmd_build_py(_build_py): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() _build_py.run(self) # now locate _version.py in the new build/ directory and replace # it with an updated value if cfg.versionfile_build: target_versionfile = os.path.join(self.build_lib, cfg.versionfile_build) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) cmds["build_py"] = cmd_build_py if "cx_Freeze" in sys.modules: # cx_freeze enabled? from cx_Freeze.dist import build_exe as _build_exe class cmd_build_exe(_build_exe): def run(self): root = get_root() cfg = get_config_from_root(root) versions = get_versions() target_versionfile = cfg.versionfile_source print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) _build_exe.run(self) os.unlink(target_versionfile) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) cmds["build_exe"] = cmd_build_exe del cmds["build_py"] # we override different "sdist" commands for both environments if "setuptools" in sys.modules: from setuptools.command.sdist import sdist as _sdist else: from distutils.command.sdist import sdist as _sdist class cmd_sdist(_sdist): def run(self): versions = get_versions() self._versioneer_generated_versions = versions # unless we update this, the command will keep using the old # version self.distribution.metadata.version = versions["version"] return _sdist.run(self) def make_release_tree(self, base_dir, files): root = get_root() cfg = get_config_from_root(root) _sdist.make_release_tree(self, base_dir, files) # now locate _version.py in the new base_dir directory # (remembering that it may be a hardlink) and replace it with an # updated value target_versionfile = os.path.join(base_dir, cfg.versionfile_source) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, self._versioneer_generated_versions) cmds["sdist"] = cmd_sdist return cmds CONFIG_ERROR = """ setup.cfg is missing the necessary Versioneer configuration. You need a section like: [versioneer] VCS = git style = pep440 versionfile_source = src/myproject/_version.py versionfile_build = myproject/_version.py tag_prefix = parentdir_prefix = myproject- You will also need to edit your setup.py to use the results: import versioneer setup(version=versioneer.get_version(), cmdclass=versioneer.get_cmdclass(), ...) Please read the docstring in ./versioneer.py for configuration instructions, edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. """ SAMPLE_CONFIG = """ # See the docstring in versioneer.py for instructions. Note that you must # re-run 'versioneer.py setup' after changing this section, and commit the # resulting files. [versioneer] #VCS = git #style = pep440 #versionfile_source = #versionfile_build = #tag_prefix = #parentdir_prefix = """ INIT_PY_SNIPPET = """ from ._version import get_versions __version__ = get_versions()['version'] del get_versions """ def do_setup(): """Main VCS-independent setup function for installing Versioneer.""" root = get_root() try: cfg = get_config_from_root(root) except (EnvironmentError, configparser.NoSectionError, configparser.NoOptionError) as e: if isinstance(e, (EnvironmentError, configparser.NoSectionError)): print("Adding sample versioneer config to setup.cfg", file=sys.stderr) with open(os.path.join(root, "setup.cfg"), "a") as f: f.write(SAMPLE_CONFIG) print(CONFIG_ERROR, file=sys.stderr) return 1 print(" creating %s" % cfg.versionfile_source) with open(cfg.versionfile_source, "w") as f: LONG = LONG_VERSION_PY[cfg.VCS] f.write(LONG % {"DOLLAR": "$", "STYLE": cfg.style, "TAG_PREFIX": cfg.tag_prefix, "PARENTDIR_PREFIX": cfg.parentdir_prefix, "VERSIONFILE_SOURCE": cfg.versionfile_source, }) ipy = os.path.join(os.path.dirname(cfg.versionfile_source), "__init__.py") if os.path.exists(ipy): try: with open(ipy, "r") as f: old = f.read() except EnvironmentError: old = "" if INIT_PY_SNIPPET not in old: print(" appending to %s" % ipy) with open(ipy, "a") as f: f.write(INIT_PY_SNIPPET) else: print(" %s unmodified" % ipy) else: print(" %s doesn't exist, ok" % ipy) ipy = None # Make sure both the top-level "versioneer.py" and versionfile_source # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so # they'll be copied into source distributions. Pip won't be able to # install the package without this. manifest_in = os.path.join(root, "MANIFEST.in") simple_includes = set() try: with open(manifest_in, "r") as f: for line in f: if line.startswith("include "): for include in line.split()[1:]: simple_includes.add(include) except EnvironmentError: pass # That doesn't cover everything MANIFEST.in can do # (http://docs.python.org/2/distutils/sourcedist.html#commands), so # it might give some false negatives. Appending redundant 'include' # lines is safe, though. if "versioneer.py" not in simple_includes: print(" appending 'versioneer.py' to MANIFEST.in") with open(manifest_in, "a") as f: f.write("include versioneer.py\n") else: print(" 'versioneer.py' already in MANIFEST.in") if cfg.versionfile_source not in simple_includes: print(" appending versionfile_source ('%s') to MANIFEST.in" % cfg.versionfile_source) with open(manifest_in, "a") as f: f.write("include %s\n" % cfg.versionfile_source) else: print(" versionfile_source already in MANIFEST.in") # Make VCS-specific changes. For git, this means creating/changing # .gitattributes to mark _version.py for export-time keyword # substitution. do_vcs_install(manifest_in, cfg.versionfile_source, ipy) return 0 def scan_setup_py(): """Validate the contents of setup.py against Versioneer's expectations.""" found = set() setters = False errors = 0 with open("setup.py", "r") as f: for line in f.readlines(): if "import versioneer" in line: found.add("import") if "versioneer.get_cmdclass()" in line: found.add("cmdclass") if "versioneer.get_version()" in line: found.add("get_version") if "versioneer.VCS" in line: setters = True if "versioneer.versionfile_source" in line: setters = True if len(found) != 3: print("") print("Your setup.py appears to be missing some important items") print("(but I might be wrong). Please make sure it has something") print("roughly like the following:") print("") print(" import versioneer") print(" setup( version=versioneer.get_version(),") print(" cmdclass=versioneer.get_cmdclass(), ...)") print("") errors += 1 if setters: print("You should remove lines like 'versioneer.VCS = ' and") print("'versioneer.versionfile_source = ' . This configuration") print("now lives in setup.cfg, and should be removed from setup.py") print("") errors += 1 return errors if __name__ == "__main__": cmd = sys.argv[1] if cmd == "setup": errors = do_setup() errors += scan_setup_py() if errors: sys.exit(1)

[['PERSON', 'Brian Warner'], ['PERSON', 'NUMCOMMITS.gHASH'], ['DATE_TIME', '0.14'], ['PERSON', 'EnvironmentError'], ['LOCATION', 'configparser'], ['PERSON', 'cfg.versionfile_source = get(parser'], ['PERSON', 'EnvironmentError'], ['PERSON', 'cfg.style'], ['PERSON', 'cfg.versionfile_source'], ['PERSON', 'EnvironmentError'], ['PERSON', 'dirname = os.path.basename(root'], ['PERSON', 'rootdir'], ['PERSON', 'dirname'], ['PERSON', 'dirname[len(parentdir_prefix'], ['PERSON', 'NotThisMethod("no'], ['LOCATION', 'print(fmt'], ['LOCATION', 'n_seen'], ['DATE_TIME', 'n_seen'], ['LOCATION', '.git'], ['LOCATION', 'cfg.style'], ['PERSON', 'NotThisMethod("no'], ['LOCATION', 'print(fmt'], ['NRP', 'f.write("%s'], ['PERSON', 'dirname = os.path.basename(root'], ['PERSON', 'rootdir'], ['PERSON', 'dirname'], ['PERSON', 'dirname[len(parentdir_prefix'], ['PERSON', 'NotThisMethod("no version_json'], ['PERSON', 'separators='], ['LOCATION', 'n_seen'], ['DATE_TIME', 'n_seen'], ['LOCATION', 'sys.modules'], ['PERSON', 'get_cmdclass'], ['PERSON', 'zipball'], ['PERSON', 'from_keywords_f'], ['PERSON', 'from_vcs_f'], ['LOCATION', 'cfg.style'], ['PERSON', 'get_cmdclass'], ['LOCATION', 'sys.modules'], ['LOCATION', 'sys.modules'], ['LOCATION', 'sys.modules'], ['LOCATION', 'sys.modules'], ['LOCATION', 'sys.modules'], ['LOCATION', 'sys.modules'], ['PERSON', 'open(cfg.versionfile_source'], ['URL', 'cfg.ve'], ['PERSON', 'cfg.style'], ['PERSON', 'cfg.versionfile_source'], ['LOCATION', 'sys.modules'], ['NRP', 'distutils.command.sdist'], ['PERSON', 'hardlink'], ['PERSON', 'cfg.versionfile_source'], ['PERSON', 'versionfile_build'], ['PERSON', 'EnvironmentError'], ['LOCATION', 'configparser.'], ['PERSON', 'EnvironmentError'], ['LOCATION', 'configparser.'], ['PERSON', 'open(cfg.versionfile_source'], ['PERSON', 'cfg.style'], ['PERSON', 'EnvironmentError'], ['LOCATION', 'MANIFEST.in'], ['PERSON', 'cfg.versionfile_source'], ['URL', 'https://github.com/warner/python-versioneer'], ['URL', 'https://pypip.in/version/versioneer/badge.svg?style=flat'], ['URL', 'https://pypi.python.org/pypi/versioneer/'], ['URL', 'https://travis-ci.org/warner/python-versioneer.png?branch=master'], ['URL', 'https://travis-ci.org/warner/python-versioneer'], ['URL', 'https://creativecommons.org/publicdomain/zero/1.0/'], ['URL', 'https://github.com/warner/python-versioneer'], ['URL', 'https://github.com/warner/python-versioneer/issues/52'], ['URL', 'http://docs.python.org/2/distutils/sourcedist.html#commands'], ['URL', 'setup.cf'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'versioneer.py'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'DISTANCE.gS'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'distutils.com'], ['URL', 'versioneer.ge'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'versioneer.py'], ['URL', 'versioneer.py'], ['URL', 'setup.cf'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'versioneer.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'MANIFEST.in'], ['URL', 'versioneer.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'setup.py'], ['URL', 'versioneer.ge'], ['URL', 'versioneer.ge'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'setup.py'], ['URL', 'untagged.NUMCOMMITS.gH'], ['URL', 'setup.py'], ['URL', 'versioneer.py'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'DISTANCE.gH'], ['URL', 'details.md'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'version.py'], ['URL', 'setup.cf'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'versioneer.VC'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'versioneer.py'], ['URL', 'make-versioneer.py'], ['URL', 'make-versioneer.py'], ['URL', 'versioneer.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'setup.cf'], ['URL', 'versioneer.py'], ['URL', 'os.path.re'], ['URL', 'os.pa'], ['URL', 'os.ge'], ['URL', 'os.path.jo'], ['URL', 'setup.py'], ['URL', 'os.path.jo'], ['URL', 'versioneer.py'], ['URL', 'os.pa'], ['URL', 'os.pa'], ['URL', 'setup.py'], ['URL', 'os.pa'], ['URL', 'os.path.re'], ['URL', 'os.pa'], ['URL', 'sys.ar'], ['URL', 'os.path.jo'], ['URL', 'setup.py'], ['URL', 'os.path.jo'], ['URL', 'versioneer.py'], ['URL', 'os.pa'], ['URL', 'os.pa'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'sys.ar'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'os.pa'], ['URL', 'versioneer.py'], ['URL', 'os.path.re'], ['URL', 'os.pa'], ['URL', 'os.pa'], ['URL', 'os.pa'], ['URL', 'versioneer.py'], ['URL', 'os.pa'], ['URL', 'setup.cf'], ['URL', 'setup.cf'], ['URL', 'configparser.No'], ['URL', 'configparser.No'], ['URL', 'versioneer.py'], ['URL', 'setup.cf'], ['URL', 'os.path.jo'], ['URL', 'setup.cf'], ['URL', 'configparser.Sa'], ['URL', 'parser.re'], ['URL', 'parser.ge'], ['URL', 'parser.ge'], ['URL', 'cfg.VC'], ['URL', 'cfg.st'], ['URL', 'cfg.ve'], ['URL', 'cfg.ve'], ['URL', 'cfg.pa'], ['URL', 'cfg.ve'], ['URL', 'git.cm'], ['URL', 'e.er'], ['URL', 'p.com'], ['URL', 'sys.ve'], ['URL', 'stdout.de'], ['URL', 'p.re'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'setup.py/versioneer.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'cfg.VC'], ['URL', 'cfg.st'], ['URL', 'cfg.pa'], ['URL', 'cfg.ve'], ['URL', 'cfg.ve'], ['URL', 'git.cm'], ['URL', 'e.er'], ['URL', 'p.com'], ['URL', 'sys.ve'], ['URL', 'stdout.de'], ['URL', 'p.re'], ['URL', 'os.path.ba'], ['URL', 'dirname.st'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'f.re'], ['URL', 'line.st'], ['URL', 're.se'], ['URL', 'mo.gr'], ['URL', 'line.st'], ['URL', 're.se'], ['URL', 'mo.gr'], ['URL', 'f.cl'], ['URL', 'refnames.st'], ['URL', 'r.st'], ['URL', 'refnames.st'], ['URL', 'r.st'], ['URL', 're.se'], ['URL', 'ref.st'], ['URL', 'version.py'], ['URL', 'os.pa'], ['URL', 'os.path.jo'], ['URL', 'sys.pl'], ['URL', 'git.cm'], ['URL', 'out.st'], ['URL', 'out.st'], ['URL', 're.se'], ['URL', 'mo.gr'], ['URL', 'tag.st'], ['URL', 'mo.gr'], ['URL', 'mo.gr'], ['URL', 'pieces.ge'], ['URL', 'DISTANCE.gH'], ['URL', '0.gH'], ['URL', 'untagged.DISTANCE.gH'], ['URL', '.post.de'], ['URL', '0.post.de'], ['URL', '.post.de'], ['URL', '0.post.de'], ['URL', 'part.is'], ['URL', '0.0.0.de'], ['URL', 'pieces.ge'], ['URL', 'replacements.it'], ['URL', 're.ma'], ['URL', 'pieces.ge'], ['URL', 'STYLES.ge'], ['URL', 'version.py'], ['URL', 'cfg.ve'], ['URL', 'os.path.re'], ['URL', 'cfg.ve'], ['URL', 'os.pa'], ['URL', 'cfg.st'], ['URL', 'cfg.pa'], ['URL', 'cfg.pa'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'f.re'], ['URL', 'line.st'], ['URL', 're.se'], ['URL', 'mo.gr'], ['URL', 'line.st'], ['URL', 're.se'], ['URL', 'mo.gr'], ['URL', 'f.cl'], ['URL', 'refnames.st'], ['URL', 'r.st'], ['URL', 'refnames.st'], ['URL', 'r.st'], ['URL', 're.se'], ['URL', 'ref.st'], ['URL', 'version.py'], ['URL', 'os.pa'], ['URL', 'os.path.jo'], ['URL', 'sys.pl'], ['URL', 'git.cm'], ['URL', 'out.st'], ['URL', 'out.st'], ['URL', 're.se'], ['URL', 'mo.gr'], ['URL', 'tag.st'], ['URL', 'mo.gr'], ['URL', 'mo.gr'], ['URL', 'version.py'], ['URL', 'sys.pl'], ['URL', 'git.cm'], ['URL', 'os.pa'], ['URL', 'os.path.re'], ['URL', 'versioneer.py'], ['URL', 'f.re'], ['URL', 'line.st'], ['URL', 'line.st'], ['URL', 'f.cl'], ['URL', 'f.cl'], ['URL', 'os.path.ba'], ['URL', 'dirname.st'], ['URL', 'versioneer.py'], ['URL', 'version.py'], ['URL', 'f.re'], ['URL', 'version.py'], ['URL', 're.se'], ['URL', 'version.py'], ['URL', 'mo.gr'], ['URL', 'version.py'], ['URL', 'pieces.ge'], ['URL', 'DISTANCE.gH'], ['URL', '0.gH'], ['URL', 'untagged.DISTANCE.gH'], ['URL', '.post.de'], ['URL', '0.post.de'], ['URL', '.post.de'], ['URL', '0.post.de'], ['URL', 'part.is'], ['URL', '0.0.0.de'], ['URL', 'pieces.ge'], ['URL', 'replacements.it'], ['URL', 'name.re'], ['URL', 're.ma'], ['URL', 'pieces.ge'], ['URL', 'STYLES.ge'], ['URL', 'sys.mo'], ['URL', 'cmdclass.py'], ['URL', 'sys.mo'], ['URL', 'cfg.VC'], ['URL', 'setup.cf'], ['URL', 'HANDLERS.ge'], ['URL', 'cfg.VC'], ['URL', 'cfg.VC'], ['URL', 'cfg.ve'], ['URL', 'cfg.ve'], ['URL', 'versioneer.ve'], ['URL', 'os.path.jo'], ['URL', 'cfg.ve'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'handlers.ge'], ['URL', 'handlers.ge'], ['URL', 'handlers.ge'], ['URL', 'cfg.st'], ['URL', 'cfg.pa'], ['URL', 'cfg.pa'], ['URL', 'sys.mo'], ['URL', 'sys.mo'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'sys.mo'], ['URL', 'setup.py'], ['URL', 'sys.mo'], ['URL', 'sys.mo'], ['URL', 'distutils.co'], ['URL', 'vers.ge'], ['URL', 'vers.ge'], ['URL', 'sys.mo'], ['URL', 'setuptools.com'], ['URL', 'distutils.com'], ['URL', 'py.ru'], ['URL', 'version.py'], ['URL', 'cfg.ve'], ['URL', 'os.path.jo'], ['URL', 'cfg.ve'], ['URL', 'sys.mo'], ['URL', 'cfg.ve'], ['URL', 'exe.ru'], ['URL', 'cfg.VC'], ['URL', 'cfg.st'], ['URL', 'cfg.pa'], ['URL', 'cfg.ve'], ['URL', 'sys.mo'], ['URL', 'setuptools.command.sd'], ['URL', 'distutils.command.sd'], ['URL', 'self.distribution.metadata.ve'], ['URL', 'sdist.ru'], ['URL', 'sdist.ma'], ['URL', 'version.py'], ['URL', 'os.path.jo'], ['URL', 'cfg.ve'], ['URL', 'setup.cf'], ['URL', 'version.py'], ['URL', 'version.py'], ['URL', 'setup.py'], ['URL', 'versioneer.ge'], ['URL', 'versioneer.ge'], ['URL', 'versioneer.py'], ['URL', 'setup.cf'], ['URL', 'versioneer.py'], ['URL', 'versioneer.py'], ['URL', 'versioneer.py'], ['URL', 'configparser.No'], ['URL', 'configparser.No'], ['URL', 'configparser.No'], ['URL', 'setup.cf'], ['URL', 'sys.st'], ['URL', 'os.path.jo'], ['URL', 'setup.cf'], ['URL', 'sys.st'], ['URL', 'cfg.ve'], ['URL', 'cfg.ve'], ['URL', 'cfg.VC'], ['URL', 'cfg.st'], ['URL', 'cfg.pa'], ['URL', 'cfg.ve'], ['URL', 'os.path.jo'], ['URL', 'os.pa'], ['URL', 'cfg.ve'], ['URL', 'os.pa'], ['URL', 'f.re'], ['URL', 'versioneer.py'], ['URL', 'version.py'], ['URL', 'MANIFEST.in'], ['URL', 'os.path.jo'], ['URL', 'MANIFEST.in'], ['URL', 'line.st'], ['URL', 'includes.ad'], ['URL', 'MANIFEST.in'], ['URL', 'versioneer.py'], ['URL', 'versioneer.py'], ['URL', 'MANIFEST.in'], ['URL', 'versioneer.py'], ['URL', 'versioneer.py'], ['URL', 'MANIFEST.in'], ['URL', 'cfg.ve'], ['URL', 'MANIFEST.in'], ['URL', 'cfg.ve'], ['URL', 'cfg.ve'], ['URL', 'MANIFEST.in'], ['URL', 'version.py'], ['URL', 'cfg.ve'], ['URL', 'setup.py'], ['URL', 'setup.py'], ['URL', 'f.re'], ['URL', 'found.ad'], ['URL', 'versioneer.ge'], ['URL', 'found.ad'], ['URL', 'versioneer.ge'], ['URL', 'found.ad'], ['URL', 'versioneer.VC'], ['URL', 'versioneer.ve'], ['URL', 'setup.py'], ['URL', 'versioneer.ge'], ['URL', 'versioneer.ge'], ['URL', 'versioneer.VC'], ['URL', 'versioneer.ve'], ['URL', 'setup.cf'], ['URL', 'setup.py'], ['URL', 'sys.ar']]

# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et: # Copyright 2017-2021 Florian Bruhin (The Compiler) dummy@email.com # # This file is part of qutebrowser. # # qutebrowser 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. # # qutebrowser 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 qutebrowser. If not, see <http://www.gnu.org/licenses/>. """Dialogs shown when there was a problem with a backend choice.""" import os import sys import functools import html import enum import shutil import argparse import dataclasses from typing import Any, List, Sequence, Tuple, Optional from PyQt5.QtCore import Qt from PyQt5.QtWidgets import (QDialog, QPushButton, QHBoxLayout, QVBoxLayout, QLabel, QMessageBox, QWidget) from PyQt5.QtNetwork import QSslSocket from qutebrowser.config import config, configfiles from qutebrowser.utils import (usertypes, version, qtutils, log, utils, standarddir) from qutebrowser.misc import objects, msgbox, savemanager, quitter class _Result(enum.IntEnum): """The result code returned by the backend problem dialog.""" quit = QDialog.Accepted + 1 restart = QDialog.Accepted + 2 restart_webkit = QDialog.Accepted + 3 restart_webengine = QDialog.Accepted + 4 @dataclasses.dataclass class _Button: """A button passed to BackendProblemDialog.""" text: str setting: str value: Any default: bool = False def _other_backend(backend: usertypes.Backend) -> Tuple[usertypes.Backend, str]: """Get the other backend enum/setting for a given backend.""" other_backend = { usertypes.Backend.QtWebKit: usertypes.Backend.QtWebEngine, usertypes.Backend.QtWebEngine: usertypes.Backend.QtWebKit, }[backend] other_setting = other_backend.name.lower()[2:] return (other_backend, other_setting) def _error_text(because: str, text: str, backend: usertypes.Backend) -> str: """Get an error text for the given information.""" other_backend, other_setting = _other_backend(backend) if other_backend == usertypes.Backend.QtWebKit: warning = ("<i>Note that QtWebKit hasn't been updated since " "July 2017 (including security updates).</i>") suffix = " (not recommended)" else: warning = "" suffix = "" return ("<b>Failed to start with the {backend} backend!</b>" "<p>qutebrowser tried to start with the {backend} backend but " "failed because {because}.</p>{text}" "<p><b>Forcing the {other_backend.name} backend{suffix}</b></p>" "<p>This forces usage of the {other_backend.name} backend by " "setting the <i>backend = '{other_setting}'</i> option " "(if you have a <i>config.py</i> file, you'll need to set " "this manually). {warning}</p>".format( backend=backend.name, because=because, text=text, other_backend=other_backend, other_setting=other_setting, warning=warning, suffix=suffix)) class _Dialog(QDialog): """A dialog which gets shown if there are issues with the backend.""" def __init__(self, *, because: str, text: str, backend: usertypes.Backend, buttons: Sequence[_Button] = None, parent: QWidget = None) -> None: super().__init__(parent) vbox = QVBoxLayout(self) other_backend, other_setting = _other_backend(backend) text = _error_text(because, text, backend) label = QLabel(text) label.setWordWrap(True) label.setTextFormat(Qt.RichText) vbox.addWidget(label) hbox = QHBoxLayout() buttons = [] if buttons is None else buttons quit_button = QPushButton("Quit") quit_button.clicked.connect(lambda: self.done(_Result.quit)) hbox.addWidget(quit_button) backend_text = "Force {} backend".format(other_backend.name) if other_backend == usertypes.Backend.QtWebKit: backend_text += ' (not recommended)' backend_button = QPushButton(backend_text) backend_button.clicked.connect(functools.partial( self._change_setting, 'backend', other_setting)) hbox.addWidget(backend_button) for button in buttons: btn = QPushButton(button.text) btn.setDefault(button.default) btn.clicked.connect(functools.partial( self._change_setting, button.setting, button.value)) hbox.addWidget(btn) vbox.addLayout(hbox) def _change_setting(self, setting: str, value: str) -> None: """Change the given setting and restart.""" config.instance.set_obj(setting, value, save_yaml=True) if setting == 'backend' and value == 'webkit': self.done(_Result.restart_webkit) elif setting == 'backend' and value == 'webengine': self.done(_Result.restart_webengine) else: self.done(_Result.restart) @dataclasses.dataclass class _BackendImports: """Whether backend modules could be imported.""" webkit_error: Optional[str] = None webengine_error: Optional[str] = None class _BackendProblemChecker: """Check for various backend-specific issues.""" def __init__(self, *, no_err_windows: bool, save_manager: savemanager.SaveManager) -> None: self._save_manager = save_manager self._no_err_windows = no_err_windows def _show_dialog(self, *args: Any, **kwargs: Any) -> None: """Show a dialog for a backend problem.""" if self._no_err_windows: text = _error_text(*args, **kwargs) print(text, file=sys.stderr) sys.exit(usertypes.Exit.err_init) dialog = _Dialog(*args, **kwargs) status = dialog.exec() self._save_manager.save_all(is_exit=True) if status in [_Result.quit, QDialog.Rejected]: pass elif status == _Result.restart_webkit: quitter.instance.restart(override_args={'backend': 'webkit'}) elif status == _Result.restart_webengine: quitter.instance.restart(override_args={'backend': 'webengine'}) elif status == _Result.restart: quitter.instance.restart() else: raise utils.Unreachable(status) sys.exit(usertypes.Exit.err_init) def _nvidia_shader_workaround(self) -> None: """Work around QOpenGLShaderProgram issues. See https://bugs.launchpad.net/ubuntu/+source/python-qt4/+bug/941826 """ self._assert_backend(usertypes.Backend.QtWebEngine) utils.libgl_workaround() def _xwayland_options(self) -> Tuple[str, List[_Button]]: """Get buttons/text for a possible XWayland solution.""" buttons = [] text = "<p>You can work around this in one of the following ways:</p>" if 'DISPLAY' in os.environ: # XWayland is available, but QT_QPA_PLATFORM=wayland is set buttons.append( _Button("Force XWayland", 'qt.force_platform', 'xcb')) text += ("<p><b>Force Qt to use XWayland</b></p>" "<p>This allows you to use the newer QtWebEngine backend " "(based on Chromium). " "This sets the <i>qt.force_platform = 'xcb'</i> option " "(if you have a <i>config.py</i> file, you'll need to " "set this manually).</p>") else: text += ("<p><b>Set up XWayland</b></p>" "<p>This allows you to use the newer QtWebEngine backend " "(based on Chromium). ") return text, buttons def _handle_wayland_webgl(self) -> None: """On older graphic hardware, WebGL on Wayland causes segfaults. See https://github.com/qutebrowser/qutebrowser/issues/5313 """ self._assert_backend(usertypes.Backend.QtWebEngine) if os.environ.get('QUTE_SKIP_WAYLAND_WEBGL_CHECK'): return platform = objects.qapp.platformName() if platform not in ['wayland', 'wayland-egl']: return # Only Qt 5.14 should be affected if not qtutils.version_check('5.14', compiled=False): return if qtutils.version_check('5.15', compiled=False): return # Newer graphic hardware isn't affected opengl_info = version.opengl_info() if (opengl_info is None or opengl_info.gles or opengl_info.version is None or opengl_info.version >= (4, 3)): return # If WebGL is turned off, we're fine if not config.val.content.webgl: return text, buttons = self._xwayland_options() buttons.append(_Button("Turn off WebGL (recommended)", 'content.webgl', False)) text += ("<p><b>Disable WebGL (recommended)</b></p>" "This sets the <i>content.webgl = False</i> option " "(if you have a <i>config.py</i> file, you'll need to " "set this manually).</p>") self._show_dialog(backend=usertypes.Backend.QtWebEngine, because=("of frequent crashes with Qt 5.14 on " "Wayland with older graphics hardware"), text=text, buttons=buttons) def _try_import_backends(self) -> _BackendImports: """Check whether backends can be imported and return BackendImports.""" # pylint: disable=unused-import results = _BackendImports() try: from PyQt5 import QtWebKit from PyQt5.QtWebKit import qWebKitVersion from PyQt5 import QtWebKitWidgets except (ImportError, ValueError) as e: results.webkit_error = str(e) else: if not qtutils.is_new_qtwebkit(): results.webkit_error = "Unsupported legacy QtWebKit found" try: from PyQt5 import QtWebEngineWidgets except (ImportError, ValueError) as e: results.webengine_error = str(e) return results def _handle_ssl_support(self, fatal: bool = False) -> None: """Check for full SSL availability. If "fatal" is given, show an error and exit. """ if QSslSocket.supportsSsl(): return if qtutils.version_check('5.12.4'): version_text = ("If you use OpenSSL 1.0 with a PyQt package from " "PyPI (e.g. on Ubuntu 16.04), you will need to " "build OpenSSL 1.1 from sources and set " "LD_LIBRARY_PATH accordingly.") else: version_text = ("If you use OpenSSL 1.1 with a PyQt package from " "PyPI (e.g. on Archlinux or Debian Stretch), you " "need to set LD_LIBRARY_PATH to the path of " "OpenSSL 1.0 or use Qt >= 5.12.4.") text = ("Could not initialize QtNetwork SSL support. {} This only " "affects downloads and :adblock-update.".format(version_text)) if fatal: errbox = msgbox.msgbox(parent=None, title="SSL error", text="Could not initialize SSL support.", icon=QMessageBox.Critical, plain_text=False) errbox.exec() sys.exit(usertypes.Exit.err_init) assert not fatal log.init.warning(text) def _check_backend_modules(self) -> None: """Check for the modules needed for QtWebKit/QtWebEngine.""" imports = self._try_import_backends() if not imports.webkit_error and not imports.webengine_error: return elif imports.webkit_error and imports.webengine_error: text = ("<p>qutebrowser needs QtWebKit or QtWebEngine, but " "neither could be imported!</p>" "<p>The errors encountered were:<ul>" "<li><b>QtWebKit:</b> {webkit_error}" "<li><b>QtWebEngine:</b> {webengine_error}" "</ul></p>".format( webkit_error=html.escape(imports.webkit_error), webengine_error=html.escape(imports.webengine_error))) errbox = msgbox.msgbox(parent=None, title="No backend library found!", text=text, icon=QMessageBox.Critical, plain_text=False) errbox.exec() sys.exit(usertypes.Exit.err_init) elif objects.backend == usertypes.Backend.QtWebKit: if not imports.webkit_error: return self._show_dialog( backend=usertypes.Backend.QtWebKit, because="QtWebKit could not be imported", text="<p><b>The error encountered was:</b><br/>{}</p>".format( html.escape(imports.webkit_error)) ) elif objects.backend == usertypes.Backend.QtWebEngine: if not imports.webengine_error: return self._show_dialog( backend=usertypes.Backend.QtWebEngine, because="QtWebEngine could not be imported", text="<p><b>The error encountered was:</b><br/>{}</p>".format( html.escape(imports.webengine_error)) ) raise utils.Unreachable def _handle_cache_nuking(self) -> None: """Nuke the QtWebEngine cache if the Qt version changed. WORKAROUND for https://bugreports.qt.io/browse/QTBUG-72532 """ if not configfiles.state.qt_version_changed: return # Only nuke the cache in cases where we know there are problems. # It seems these issues started with Qt 5.12. # They should be fixed with Qt 5.12.5: # https://codereview.qt-project.org/c/qt/qtwebengine-chromium/+/265408 if qtutils.version_check('5.12.5', compiled=False): return log.init.info("Qt version changed, nuking QtWebEngine cache") cache_dir = os.path.join(standarddir.cache(), 'webengine') if os.path.exists(cache_dir): shutil.rmtree(cache_dir) def _handle_serviceworker_nuking(self) -> None: """Nuke the service workers directory if the Qt version changed. WORKAROUND for: https://bugreports.qt.io/browse/QTBUG-72532 https://bugreports.qt.io/browse/QTBUG-82105 """ if ('serviceworker_workaround' not in configfiles.state['general'] and qtutils.version_check('5.14', compiled=False)): # Nuke the service worker directory once for every install with Qt # 5.14, given that it seems to cause a variety of segfaults. configfiles.state['general']['serviceworker_workaround'] = '514' affected = True else: # Otherwise, just nuke it when the Qt version changed. affected = configfiles.state.qt_version_changed if not affected: return service_worker_dir = os.path.join(standarddir.data(), 'webengine', 'Service Worker') bak_dir = service_worker_dir + '-bak' if not os.path.exists(service_worker_dir): return log.init.info("Qt version changed, removing service workers") # Keep one backup around - we're not 100% sure what persistent data # could be in there, but this folder can grow to ~300 MB. if os.path.exists(bak_dir): shutil.rmtree(bak_dir) shutil.move(service_worker_dir, bak_dir) def _assert_backend(self, backend: usertypes.Backend) -> None: assert objects.backend == backend, objects.backend def check(self) -> None: """Run all checks.""" self._check_backend_modules() if objects.backend == usertypes.Backend.QtWebEngine: self._handle_ssl_support() self._nvidia_shader_workaround() self._handle_wayland_webgl() self._handle_cache_nuking() self._handle_serviceworker_nuking() else: self._assert_backend(usertypes.Backend.QtWebKit) self._handle_ssl_support(fatal=True) def init(*, args: argparse.Namespace, save_manager: savemanager.SaveManager) -> None: """Run all checks.""" checker = _BackendProblemChecker(no_err_windows=args.no_err_windows, save_manager=save_manager) checker.check()

[['EMAIL_ADDRESS', 'dummy@email.com'], ['PERSON', 'sw=4'], ['DATE_TIME', '2017-2021'], ['PERSON', 'Florian Bruhin'], ['LOCATION', 'qutebrowser'], ['PERSON', 'qutebrowser'], ['PERSON', 'QPushButton'], ['LOCATION', 'configfiles'], ['PERSON', 'standarddir'], ['LOCATION', 'Result(enum'], ['DATE_TIME', 'July 2017'], ['PERSON', 'vbox'], ['PERSON', 'hbox'], ['PERSON', 'quit_button'], ['LOCATION', 'wayland'], ['LOCATION', 'Wayland'], ['DATE_TIME', 'Only Qt 5.14'], ['PERSON', "qtutils.version_check('5.15"], ['DATE_TIME', '5.14'], ['LOCATION', 'Wayland'], ['NRP', 'PyQt'], ['NRP', 'PyQt'], ['PERSON', 'text="Could'], ['DATE_TIME', '5.14'], ['URL', 'http://www.gnu.org/licenses/'], ['URL', 'https://bugs.launchpad.net/ubuntu/+source/python-qt4/+bug/941826'], ['URL', 'https://github.com/qutebrowser/qutebrowser/issues/5313'], ['URL', 'https://bugreports.qt.io/browse/QTBUG-72532'], ['URL', 'https://codereview.qt-project.org/c/qt/qtwebengine-chromium/+/265408'], ['URL', 'https://bugreports.qt.io/browse/QTBUG-72532'], ['URL', 'https://bugreports.qt.io/browse/QTBUG-82105'], ['URL', 'email.com'], ['URL', 'qutebrowser.co'], ['URL', 'enum.Int'], ['URL', 'QDialog.Ac'], ['URL', 'QDialog.Ac'], ['URL', 'QDialog.Ac'], ['URL', 'QDialog.Ac'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'backend.na'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'backend.na'], ['URL', 'backend.na'], ['URL', 'config.py'], ['URL', 'backend.na'], ['URL', 'usertypes.Ba'], ['URL', 'label.se'], ['URL', 'label.se'], ['URL', 'vbox.ad'], ['URL', 'button.clicked.co'], ['URL', 'self.do'], ['URL', 'hbox.ad'], ['URL', 'backend.na'], ['URL', 'usertypes.Ba'], ['URL', 'button.clicked.co'], ['URL', 'functools.pa'], ['URL', 'hbox.ad'], ['URL', 'btn.se'], ['URL', 'button.de'], ['URL', 'btn.clicked.co'], ['URL', 'functools.pa'], ['URL', 'button.se'], ['URL', 'button.va'], ['URL', 'hbox.ad'], ['URL', 'vbox.ad'], ['URL', 'config.instance.se'], ['URL', 'self.do'], ['URL', 'Result.re'], ['URL', 'self.do'], ['URL', 'Result.re'], ['URL', 'self.do'], ['URL', 'Result.re'], ['URL', 'savemanager.Sa'], ['URL', 'sys.st'], ['URL', 'usertypes.Exit.er'], ['URL', 'manager.sa'], ['URL', 'QDialog.Re'], ['URL', 'Result.re'], ['URL', 'quitter.instance.re'], ['URL', 'Result.re'], ['URL', 'quitter.instance.re'], ['URL', 'Result.re'], ['URL', 'quitter.instance.re'], ['URL', 'usertypes.Exit.er'], ['URL', 'usertypes.Ba'], ['URL', 'utils.li'], ['URL', 'qt.fo'], ['URL', 'qt.fo'], ['URL', 'config.py'], ['URL', 'usertypes.Ba'], ['URL', 'os.environ.ge'], ['URL', 'objects.qapp.pl'], ['URL', 'qtutils.ve'], ['URL', 'qtutils.ve'], ['URL', 'info.gl'], ['URL', 'info.ve'], ['URL', 'info.ve'], ['URL', 'config.val.co'], ['URL', 'config.py'], ['URL', 'usertypes.Ba'], ['URL', 'qtutils.is'], ['URL', 'QSslSocket.su'], ['URL', 'qtutils.ve'], ['URL', 'msgbox.ms'], ['URL', 'QMessageBox.Cr'], ['URL', 'usertypes.Exit.er'], ['URL', 'log.in'], ['URL', 'html.es'], ['URL', 'html.es'], ['URL', 'msgbox.ms'], ['URL', 'QMessageBox.Cr'], ['URL', 'usertypes.Exit.er'], ['URL', 'objects.ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'html.es'], ['URL', 'objects.ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'html.es'], ['URL', 'configfiles.st'], ['URL', 'qtutils.ve'], ['URL', 'log.init.in'], ['URL', 'os.path.jo'], ['URL', 'standarddir.ca'], ['URL', 'os.pa'], ['URL', 'configfiles.st'], ['URL', 'qtutils.ve'], ['URL', 'configfiles.st'], ['URL', 'configfiles.st'], ['URL', 'os.path.jo'], ['URL', 'os.pa'], ['URL', 'log.init.in'], ['URL', 'os.pa'], ['URL', 'shutil.mo'], ['URL', 'usertypes.Ba'], ['URL', 'objects.ba'], ['URL', 'objects.ba'], ['URL', 'objects.ba'], ['URL', 'usertypes.Ba'], ['URL', 'usertypes.Ba'], ['URL', 'argparse.Na'], ['URL', 'savemanager.Sa'], ['URL', 'args.no'], ['URL', 'checker.ch']]