2018-08-06 20:03 UTC

AUR

NAME
    AUR

PACKAGE CONTENTS
    AurPkg
    Aurtomatic
    PkgList
    RPC
    SRCINFO
    common

AUR.AurPkg

NAME
    AUR.AurPkg

CLASSES
    XCPF.ArchPkg.BuildablePkg(builtins.object)
        AurBuildablePkg
    XCPF.ArchPkg.BuildablePkgFactory(builtins.object)
        AurBuildablePkgFactory
    XCPF.ArchPkg.PkgSet(builtins.object)
        AurPkgSet
    
    class AurBuildablePkg(XCPF.ArchPkg.BuildablePkg)
     |  AurBuildablePkg(arch, pkg, asi=None)
     |  
     |  A wrapper object around different package objects to faciliate the generation
     |  of build scripts.
     |  
     |  Method resolution order:
     |      AurBuildablePkg
     |      XCPF.ArchPkg.BuildablePkg
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, arch, pkg, asi=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  buildable(self)
     |      Return a boolean indicating if this package is buildable.
     |  
     |  checkdeps(self)
     |      Iterate over check dependencies.
     |  
     |  deps(self)
     |      Iterate over runtime dependencies.
     |  
     |  get_srcinfo(self)
     |      # Lazy retrieval.
     |  
     |  last_modified(self)
     |      Return the last modification time, in UNIX format.
     |  
     |  maintainers(self)
     |      Iterate over current maintainers.
     |  
     |  makedeps(self)
     |      Iterate over build dependencies.
     |  
     |  pkgbase(self)
     |      Return the package base.
     |  
     |  pkgname(self)
     |      Return the package name.
     |  
     |  repo(self)
     |      Return the package repository or a suitable origin identifier.
     |  
     |  version(self)
     |      Return the package version.
     |  
     |  with_arch_deps(self, field)
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from XCPF.ArchPkg.BuildablePkg:
     |  
     |  __eq__(self, other)
     |      Return self==value.
     |  
     |  __ge__(self, other, NotImplemented=NotImplemented)
     |      Return a >= b.  Computed by @total_ordering from (not a < b).
     |  
     |  __gt__(self, other, NotImplemented=NotImplemented)
     |      Return a > b.  Computed by @total_ordering from (not a < b) and (a != b).
     |  
     |  __le__(self, other, NotImplemented=NotImplemented)
     |      Return a <= b.  Computed by @total_ordering from (a < b) or (a == b).
     |  
     |  __lt__(self, other)
     |      Return self<value.
     |  
     |  alldeps(self)
     |      Iterate over all dependencies.
     |  
     |  qualified_pkgbase(self)
     |      Returned the pkgbase with the repo prefix.
     |  
     |  qualified_pkgname(self)
     |      Returned the pkgname with the repo prefix.
     |  
     |  trusted(self)
     |      Return a boolean indicating if this package should be intrinsically trusted.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from XCPF.ArchPkg.BuildablePkg:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from XCPF.ArchPkg.BuildablePkg:
     |  
     |  __hash__ = None
    
    class AurBuildablePkgFactory(XCPF.ArchPkg.BuildablePkgFactory)
     |  AurBuildablePkgFactory(arch, *args, asi=None, **kwargs)
     |  
     |  Wrapper class to convert AUR packages to AurBuildablePkgs.
     |  
     |  arch: Target architecture.
     |  asi: AUR.SRCINFO.AurSrcinfo instance.
     |  
     |  Method resolution order:
     |      AurBuildablePkgFactory
     |      XCPF.ArchPkg.BuildablePkgFactory
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, arch, *args, asi=None, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  pkg(self, pkg)
     |      Convert a package to a buildable package if possible.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from XCPF.ArchPkg.BuildablePkgFactory:
     |  
     |  pkgs(self, pkgs, *args, **kwargs)
     |      Generator around pkg method.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from XCPF.ArchPkg.BuildablePkgFactory:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class AurPkgSet(XCPF.ArchPkg.PkgSet)
     |  AurPkgSet(pkgs=None)
     |  
     |  Sets of packages with associated operations such as unions and intersections.
     |  
     |  The accessors should be a dictionary of functions that accept a package as
     |  the sole argument and return the property identified by the key in the
     |  dictionary associated with that function. The required keys are:
     |  
     |  * name
     |  * version
     |  * groups
     |  
     |  Method resolution order:
     |      AurPkgSet
     |      XCPF.ArchPkg.PkgSet
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, pkgs=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from XCPF.ArchPkg.PkgSet:
     |  
     |  __add__(self, other)
     |  
     |  __and__(self, other)
     |  
     |  __bool__(self)
     |  
     |  __contains__(self, pkg)
     |  
     |  __iadd__(self, other)
     |  
     |  __iand__(self, other)
     |  
     |  __ior__(self, other)
     |  
     |  __isub__(self, other)
     |  
     |  __iter__(self)
     |  
     |  __len__(self)
     |  
     |  __or__(self, other)
     |  
     |  __repr__(self)
     |      Return repr(self).
     |  
     |  add(self, pkg)
     |  
     |  addmany(self, pkgs)
     |  
     |  clear(self)
     |  
     |  copy(self)
     |  
     |  ignore(self, names, groups)
     |  
     |  names(self)
     |  
     |  remove(self, pkg)
     |  
     |  remove_version(self, name, version)
     |  
     |  removemany(self, pkgs)
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from XCPF.ArchPkg.PkgSet:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

AUR.Aurtomatic

NAME
    AUR.Aurtomatic

CLASSES
    builtins.Exception(builtins.BaseException)
        AurtomaticError
    builtins.object
        Aurtomatic
        CookieWrapper
    html.parser.HTMLParser(_markupbase.ParserBase)
        AccountScraper
        TokenScraper
    
    class AccountScraper(html.parser.HTMLParser)
     |  Scrape account data from the account search results page.
     |  
     |  Method resolution order:
     |      AccountScraper
     |      html.parser.HTMLParser
     |      _markupbase.ParserBase
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self)
     |      Initialize and reset this instance.
     |      
     |      If convert_charrefs is True (the default), all character references
     |      are automatically converted to the corresponding Unicode characters.
     |  
     |  handle_data(self, data)
     |  
     |  handle_endtag(self, tag)
     |  
     |  handle_starttag(self, tag, attrs)
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from html.parser.HTMLParser:
     |  
     |  check_for_whole_start_tag(self, i)
     |      # Internal -- check to see if we have a complete starttag; return end
     |      # or -1 if incomplete.
     |  
     |  clear_cdata_mode(self)
     |  
     |  close(self)
     |      Handle any buffered data.
     |  
     |  feed(self, data)
     |      Feed data to the parser.
     |      
     |      Call this as often as you want, with as little or as much text
     |      as you want (may include '\n').
     |  
     |  get_starttag_text(self)
     |      Return full source of start tag: '<...>'.
     |  
     |  goahead(self, end)
     |      # Internal -- handle data as far as reasonable.  May leave state
     |      # and data to be processed by a subsequent call.  If 'end' is
     |      # true, force handling all data as if followed by EOF marker.
     |  
     |  handle_charref(self, name)
     |      # Overridable -- handle character reference
     |  
     |  handle_comment(self, data)
     |      # Overridable -- handle comment
     |  
     |  handle_decl(self, decl)
     |      # Overridable -- handle declaration
     |  
     |  handle_entityref(self, name)
     |      # Overridable -- handle entity reference
     |  
     |  handle_pi(self, data)
     |      # Overridable -- handle processing instruction
     |  
     |  handle_startendtag(self, tag, attrs)
     |      # Overridable -- finish processing of start+end tag: <tag.../>
     |  
     |  parse_bogus_comment(self, i, report=1)
     |      # Internal -- parse bogus comment, return length or -1 if not terminated
     |      # see http://www.w3.org/TR/html5/tokenization.html#bogus-comment-state
     |  
     |  parse_endtag(self, i)
     |      # Internal -- parse endtag, return end or -1 if incomplete
     |  
     |  parse_html_declaration(self, i)
     |      # Internal -- parse html declarations, return length or -1 if not terminated
     |      # See w3.org/TR/html5/tokenization.html#markup-declaration-open-state
     |      # See also parse_declaration in _markupbase
     |  
     |  parse_pi(self, i)
     |      # Internal -- parse processing instr, return end or -1 if not terminated
     |  
     |  parse_starttag(self, i)
     |      # Internal -- handle starttag, return end or -1 if not terminated
     |  
     |  reset(self)
     |      Reset this instance.  Loses all unprocessed data.
     |  
     |  set_cdata_mode(self, elem)
     |  
     |  unescape(self, s)
     |      # Internal -- helper to remove special character quoting
     |  
     |  unknown_decl(self, data)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from html.parser.HTMLParser:
     |  
     |  CDATA_CONTENT_ELEMENTS = ('script', 'style')
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from _markupbase.ParserBase:
     |  
     |  error(self, message)
     |  
     |  getpos(self)
     |      Return current line number and offset.
     |  
     |  parse_comment(self, i, report=1)
     |      # Internal -- parse comment, return length or -1 if not terminated
     |  
     |  parse_declaration(self, i)
     |      # Internal -- parse declaration (for use by subclasses).
     |  
     |  parse_marked_section(self, i, report=1)
     |      # Internal -- parse a marked section
     |      # Override this to handle MS-word extension syntax <![if word]>content<![endif]>
     |  
     |  updatepos(self, i, j)
     |      # Internal -- update line number and offset.  This should be
     |      # called for each piece of data exactly once, in order -- in other
     |      # words the concatenation of all the input strings to this
     |      # function should be exactly the entire input.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _markupbase.ParserBase:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class Aurtomatic(builtins.object)
     |  Aurtomatic(cookiejar_path=None, cookiejar=None, token=None)
     |  
     |  A user object for interactive actions.
     |  
     |  Methods defined here:
     |  
     |  __init__(self, cookiejar_path=None, cookiejar=None, token=None)
     |      cookiejar: a MozillaCookieJar object
     |      
     |      token: a user token for submitting form data
     |  
     |  get_info(self, pkgname)
     |      Get package information from the RPC interface.
     |  
     |  initialize(self, user=None, passwd=None, login_file=None, cookiejar_path=None)
     |      Reload token and log in if necessary.
     |  
     |  load_cookies(self, path=None)
     |      Load cookie jar.
     |  
     |  load_token(self)
     |      Attempt to load the hidden token. If the token is empty after this operation
     |      then the user is not currently logged in, so it doubles as a login check.
     |  
     |  login(self, user=None, passwd=None, login_file=None, remember_me=True)
     |      Log in to the AUR.
     |  
     |  remove_cookies(self, path=None)
     |      Save cookie jar.
     |  
     |  save_cookies(self, path=None)
     |      Save cookie jar.
     |  
     |  search_accounts(self, username=None, typ=None, suspended=False, email=None, realname=None, ircname=None, sortby=None, max_results=50)
     |      Submit a search form and scrape the results.
     |      
     |      Valid types:
     |        u: normal user
     |        t: trusted user
     |        d: developer
     |        td: trusted user & developer
     |      
     |      Valid sortby options:
     |        u: user name
     |        t: account type
     |        r: real name
     |        i: IRC name
     |  
     |  submit_package_form(self, pkginfo, action, confirm=False, merge_into=None, value=None, comment=None, comment_id=None)
     |      Submit a form to the AUR.
     |  
     |  upload_pkg(*args, **kwargs)
     |      Upload a package to the AUR. This is no longer supported.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class AurtomaticError(builtins.Exception)
     |  AurtomaticError(msg)
     |  
     |  Exceptions raised by AUR interactions and related functions.
     |  
     |  Method resolution order:
     |      AurtomaticError
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, msg)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class CookieWrapper(builtins.object)
     |  CookieWrapper(path=None, action='ask', login_file=None)
     |  
     |  Methods defined here:
     |  
     |  __enter__(self)
     |      Cookie context manager.
     |  
     |  __exit__(self, typ, value, traceback)
     |      Cookie context manager.
     |  
     |  __init__(self, path=None, action='ask', login_file=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  ACTIONS = ('ask', 'keep', 'remove')
    
    class TokenScraper(html.parser.HTMLParser)
     |  Scrape the hidden token field required for submitting forms.
     |  
     |  Method resolution order:
     |      TokenScraper
     |      html.parser.HTMLParser
     |      _markupbase.ParserBase
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self)
     |      Initialize and reset this instance.
     |      
     |      If convert_charrefs is True (the default), all character references
     |      are automatically converted to the corresponding Unicode characters.
     |  
     |  handle_data(self, data)
     |  
     |  handle_endtag(self, tag)
     |  
     |  handle_starttag(self, tag, attrs)
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from html.parser.HTMLParser:
     |  
     |  check_for_whole_start_tag(self, i)
     |      # Internal -- check to see if we have a complete starttag; return end
     |      # or -1 if incomplete.
     |  
     |  clear_cdata_mode(self)
     |  
     |  close(self)
     |      Handle any buffered data.
     |  
     |  feed(self, data)
     |      Feed data to the parser.
     |      
     |      Call this as often as you want, with as little or as much text
     |      as you want (may include '\n').
     |  
     |  get_starttag_text(self)
     |      Return full source of start tag: '<...>'.
     |  
     |  goahead(self, end)
     |      # Internal -- handle data as far as reasonable.  May leave state
     |      # and data to be processed by a subsequent call.  If 'end' is
     |      # true, force handling all data as if followed by EOF marker.
     |  
     |  handle_charref(self, name)
     |      # Overridable -- handle character reference
     |  
     |  handle_comment(self, data)
     |      # Overridable -- handle comment
     |  
     |  handle_decl(self, decl)
     |      # Overridable -- handle declaration
     |  
     |  handle_entityref(self, name)
     |      # Overridable -- handle entity reference
     |  
     |  handle_pi(self, data)
     |      # Overridable -- handle processing instruction
     |  
     |  handle_startendtag(self, tag, attrs)
     |      # Overridable -- finish processing of start+end tag: <tag.../>
     |  
     |  parse_bogus_comment(self, i, report=1)
     |      # Internal -- parse bogus comment, return length or -1 if not terminated
     |      # see http://www.w3.org/TR/html5/tokenization.html#bogus-comment-state
     |  
     |  parse_endtag(self, i)
     |      # Internal -- parse endtag, return end or -1 if incomplete
     |  
     |  parse_html_declaration(self, i)
     |      # Internal -- parse html declarations, return length or -1 if not terminated
     |      # See w3.org/TR/html5/tokenization.html#markup-declaration-open-state
     |      # See also parse_declaration in _markupbase
     |  
     |  parse_pi(self, i)
     |      # Internal -- parse processing instr, return end or -1 if not terminated
     |  
     |  parse_starttag(self, i)
     |      # Internal -- handle starttag, return end or -1 if not terminated
     |  
     |  reset(self)
     |      Reset this instance.  Loses all unprocessed data.
     |  
     |  set_cdata_mode(self, elem)
     |  
     |  unescape(self, s)
     |      # Internal -- helper to remove special character quoting
     |  
     |  unknown_decl(self, data)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from html.parser.HTMLParser:
     |  
     |  CDATA_CONTENT_ELEMENTS = ('script', 'style')
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from _markupbase.ParserBase:
     |  
     |  error(self, message)
     |  
     |  getpos(self)
     |      Return current line number and offset.
     |  
     |  parse_comment(self, i, report=1)
     |      # Internal -- parse comment, return length or -1 if not terminated
     |  
     |  parse_declaration(self, i)
     |      # Internal -- parse declaration (for use by subclasses).
     |  
     |  parse_marked_section(self, i, report=1)
     |      # Internal -- parse a marked section
     |      # Override this to handle MS-word extension syntax <![if word]>content<![endif]>
     |  
     |  updatepos(self, i, j)
     |      # Internal -- update line number and offset.  This should be
     |      # called for each piece of data exactly once, in order -- in other
     |      # words the concatenation of all the input strings to this
     |      # function should be exactly the entire input.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _markupbase.ParserBase:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

FUNCTIONS
    get_default_cookiejar_path()
        Get the default path to the cookie jar.
    
    load_login_file(fpath)
        Load login name and password from file.
    
    main(args=None)
    
    parse_args(args=None)
    
    prompt_input(pkginfo, prompt)
        Prompt the user for input.
        
        The EDITOR environment variable must be set.
    
    run_main(args=None)
        Run main() with exception handling.

DATA
    ACCOUNT_RESULTS_PER_PAGE = 50
    ACTION_URL = 'https://aur.archlinux.org/pkgbase'
    DO_ACTIONS = ('adopt', 'disown', 'delete')
    FORM_ACTIONS = {'adopt': 'Adopt', 'delete': 'Delete', 'disown': 'Disow...
    INDEX_URL = 'https://aur.archlinux.org/index.php'
    LOGIN_URL = 'https://aur.archlinux.org/login/'
    PACKAGE_ACTIONS = ('unflag', 'vote', 'unvote', 'notify', 'unnotify')
    PKGSUBMIT_URL = 'https://aur.archlinux.org/submit/'
    RPC_URL = 'https://aur.archlinux.org/rpc.php'
    TOKENSCRAPER_URL = 'https://aur.archlinux.org/packages/python3-aur/'
    VALUE_ACTIONS = ('flag', 'comment', 'setkeywords')

AUR.PkgList

NAME
    AUR.PkgList

CLASSES
    builtins.object
        PkgList
    
    class PkgList(builtins.object)
     |  PkgList(path=None, ttl=900, auto_refresh=False)
     |  
     |  A class to retrieve and iterate over the list of AUR packages.
     |  
     |  Methods defined here:
     |  
     |  __init__(self, path=None, ttl=900, auto_refresh=False)
     |      path:
     |        The local path under which to store the file.
     |      
     |      ttl:
     |        The time-to-live of the cached file. This is passed to XCGF.mirror as the
     |        cache_time option.
     |      
     |      auto_refresh:
     |        If True, automatically refresh the file when needed.
     |  
     |  __iter__(self)
     |  
     |  refresh(self, force=False)
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

FUNCTIONS
    iterate_packages(path)

DATA
    PKGLIST_PATH = '/packages.gz'
    PKGLIST_URL = 'https://aur.archlinux.org/packages.gz'

AUR.RPC

NAME
    AUR.RPC - Retrieve data from the AUR via the RPC interface.

DESCRIPTION
    Results are cached in an SQLite3 database to avoid redundant queries when
    practical.
    
    For more information see https://aur.archlinux.org/rpc.php and
    https://projects.archlinux.org/aurweb.git/plain/doc/rpc.txt

CLASSES
    builtins.Exception(builtins.BaseException)
        AurError
    builtins.object
        AurRpc
    
    class AurError(builtins.Exception)
     |  AurError(msg, error=None)
     |  
     |  Exception raised by AUR objects.
     |  
     |  Method resolution order:
     |      AurError
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, msg, error=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class AurRpc(builtins.object)
     |  AurRpc(database=None, mdb=None, ttl=900, clean=False)
     |  
     |  Interact with the Arch Linux User Repository (AUR)
     |  
     |  Data retrieved via the RPC interface is cached temporarily in an SQLite3
     |  database to avoid unnecessary remote calls.
     |  
     |  Methods defined here:
     |  
     |  __init__(self, database=None, mdb=None, ttl=900, clean=False)
     |      Initialize the AUR object.
     |      
     |      database:
     |        SQLite3 database path. Leave as None to use the default path. Use
     |        ":memory:" to avoid creating a cache file. default:
     |        $XDG_CACHE_HOME/AUR/RPC.sqlite3
     |      
     |      ttl:
     |        Time to live, i.e. how long to cache individual results in the database.
     |      
     |      clean:
     |        Clean the database to remove old entries and ensure integrity.
     |  
     |  get(self, *args, **kwargs)
     |      See the documentation for _get.
     |  
     |  info(self, args)
     |      Retrieve package information.
     |  
     |  msearch(self, args)
     |      Search for packages by maintainer. Only the names are returned.
     |  
     |  search(self, args, by='name-desc', intersect=False)
     |      Search for packages.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

FUNCTIONS
    aur_query(typ, args, by='name-desc')
        Query the AUR RPC interface.
    
    convert_pkginfo(pkg)
        Convert package info fields to expected formats.
    
    download_archives(output_dir, pkgs)
        Download the AUR files to the target directory.
    
    download_git_repo(output_dir, pkgs, warn=False, pull=False)
        Download the AUR files to the target directory.
    
    format_pkginfo(pkgs)
        Format package information for display similarly to "pacman -Si".
        
        This function modified the passed packages.
    
    format_rpc_args(args)
        Ensure that the arguments are a list. If None, then a list with a single empty
        string will be returned to ensure that e.g. orphan searches work as expected.
    
    insert_full_urls(pkgs)
        Replace partial URLS with full URLS for each passed package.
    
    lst_to_txt(lst)
        Prepare a list for storage in a text field.
    
    main(args=None)
        Parse command-line arguments and print query results to STDOUT.
    
    parse_args(args=None)
        Parse command-line arguments.
        
        If no arguments are passed then arguments are read from sys.argv.
    
    rpc_info(args)
        MemoizeDB glue function for RPC info queries.
    
    rpc_search_by(args, by='name-desc')
        MemoizeDB glue function for RPC search queries.
    
    rpc_url(typ, args, by='name-desc', post=False)
        Format the RPC URL.
    
    run_main(args=None)
        Run main() with exception handling.
    
    txt_to_lst(txt)
        Convert a textified list back to a list.

DATA
    CODING = 'UTF-8'
    DISPLAY_FIELDS = ('PackageBase', 'Name', 'Version', 'Description', 'UR...
    INTEGER_FIELDS = ('FirstSubmitted', 'ID', 'LastModified', 'NumVotes', ...
    LIST_FIELDS = ('CheckDepends', 'Conflicts', 'Depends', 'Groups', 'Keyw...
    RPC_BYS = ('name', 'name-desc', 'maintainer')
    RPC_DEFAULT_BY = 'name-desc'
    RPC_MAX_ARGS = 500
    RPC_TYPES = ('info', 'search')
    RPC_URL = 'https://aur.archlinux.org/rpc.php'
    RPC_VERSION = 5

AUR.SRCINFO

NAME
    AUR.SRCINFO

CLASSES
    builtins.object
        AurSrcinfo
    
    class AurSrcinfo(builtins.object)
     |  AurSrcinfo(mdb=None, dbpath=None, ttl=900)
     |  
     |  A caching AUR .SRCINFO retriever.
     |  
     |  Methods defined here:
     |  
     |  __init__(self, mdb=None, dbpath=None, ttl=900)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  get(self, args)
     |      Iterate over the parse .SRCINFO files. Returns None if the file could not
     |      be retrieved. This expects PackageBase arguments.
     |  
     |  get_pkginfo(self, pkgbases_and_pkgnames)
     |      Retrieve package information.
     |      
     |      pkgbases_and_pkgnames: An iterator over package base and package name pairs.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  SRCINFO_TABLE = 'srcinfo'

FUNCTIONS
    get_pkginfo(srcinfo, pkgname)
        Return package information for one of the packages within the SRCINFO.
    
    insert_pkgbase(pkginfo, pkgbase)
        Insert items from the pkgbase.
    
    main(args=None)
    
    parse_srcinfo(lines)
        Parse the lines of a .SRCINFO file.
    
    read_srcinfo_file(path)
        Read a .SRCINFO file.
    
    read_srcinfo_url(url)
        Read a .SRCINFO URL.
    
    srcinfo_dbpath()
        Return a path to the .SRCINFO caching database.
    
    srcinfo_url(pkgname)
        Get the URL of the .SRCINFO file.

DATA
    PKGBASE_STRING = 'pkgbase'
    PKGLIST_URL = 'https://aur.archlinux.org/cgit/aur.git/plain/.SRCINFO?h...
    PKGNAME_STRING = 'pkgname'
    SRCINFO_PATH = '/cgit/aur.git/plain/.SRCINFO?h={}'

AUR.common

NAME
    AUR.common

DATA
    AUR_GIT_URL_FORMAT = 'https://aur.archlinux.org/{}.git'
    AUR_HOST = 'aur.archlinux.org'
    AUR_SSH_GIT_URL = 'ssh+git://aur@aur.archlinux.org'
    AUR_URL = 'https://aur.archlinux.org'
    DEFAULT_TTL = 900
    XDG_NAME = 'AUR'
Contact
echo xyne.archlinux.ca | sed 's/\./@/'
Feeds
Blog News
Validation
XHTML 1.0 Strict CSS level 3 Atom 1.0