Blame doc/api_package.rst

Packit Service 21c75c
..
Packit Service 21c75c
  Copyright (C) 2014-2018 Red Hat, Inc.
Packit Service 21c75c
Packit Service 21c75c
  This copyrighted material is made available to anyone wishing to use,
Packit Service 21c75c
  modify, copy, or redistribute it subject to the terms and conditions of
Packit Service 21c75c
  the GNU General Public License v.2, or (at your option) any later version.
Packit Service 21c75c
  This program is distributed in the hope that it will be useful, but WITHOUT
Packit Service 21c75c
  ANY WARRANTY expressed or implied, including the implied warranties of
Packit Service 21c75c
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
Packit Service 21c75c
  Public License for more details.  You should have received a copy of the
Packit Service 21c75c
  GNU General Public License along with this program; if not, write to the
Packit Service 21c75c
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
Packit Service 21c75c
  02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
Packit Service 21c75c
  source code or documentation are not subject to the GNU General Public
Packit Service 21c75c
  License and may only be used or replicated with the express permission of
Packit Service 21c75c
  Red Hat, Inc.
Packit Service 21c75c
Packit Service 21c75c
=========
Packit Service 21c75c
 Package
Packit Service 21c75c
=========
Packit Service 21c75c
Packit Service 21c75c
.. class:: dnf.package.Package
Packit Service 21c75c
Packit Service 21c75c
  Represents a unit of software management, typically corresponds to an RPM file.
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: arch
Packit Service 21c75c
Packit Service 21c75c
    Architecture of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: baseurl
Packit Service 21c75c
Packit Service 21c75c
    Baseurl of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: buildtime
Packit Service 21c75c
Packit Service 21c75c
    Seconds since the epoch when the package was built (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: chksum
Packit Service 21c75c
Packit Service 21c75c
    Tuple with package checksum and checksum type or ``None``. The checksum is returned only for
Packit Service 21c75c
    packages from repository. The checksum is not returned for installed package or packages from
Packit Service 21c75c
    commandline repository. The checksum represents @pkgid value which links primary metadata with
Packit Service 21c75c
    other repository metadata files.
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: conflicts
Packit Service 21c75c
Packit Service 21c75c
    Packages that the package conflicts with (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: debug_name
Packit Service 21c75c
Packit Service 21c75c
    The name of the debug-info package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: description
Packit Service 21c75c
Packit Service 21c75c
    The description of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: downloadsize
Packit Service 21c75c
Packit Service 21c75c
    The size of rpm package in bytes (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: epoch
Packit Service 21c75c
Packit Service 21c75c
    Epoch of the package (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: enhances
Packit Service 21c75c
Packit Service 21c75c
    Packages that the package enhances (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: evr
Packit Service 21c75c
Packit Service 21c75c
    EVR (epoch:version-revision) of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: files
Packit Service 21c75c
Packit Service 21c75c
    Files the package provides (list of strings).
Packit Service 21c75c
Packit Service dd6de2
  .. attribute:: from_repo
Packit Service dd6de2
Packit Service db8d26
    For installed packages returns id of repository from which the package was installed if such
Packit Service db8d26
    information is available in the history database. Otherwise returns an empty string (string).
Packit Service dd6de2
Packit Service 21c75c
  .. attribute:: group
Packit Service 21c75c
Packit Service 21c75c
    Group of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: hdr_chksum
Packit Service 21c75c
Packit Service 21c75c
    Tuple with package header checksum and checksum type or ``None``. The checksum is returned only for installed packages.
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: hdr_end
Packit Service 21c75c
Packit Service 21c75c
    Header end index for the package. Returns 0 for not known (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: changelogs
Packit Service 21c75c
Packit Service 21c75c
    Changelogs for the package (list of dictionaries with "timestamp", "author" and "text" keys).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: installed
Packit Service 21c75c
Packit Service 21c75c
    Returns ``True`` if the package is installed (boolean).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: installtime
Packit Service 21c75c
Packit Service 21c75c
    Seconds since the epoch when the package was installed (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: installsize
Packit Service 21c75c
Packit Service 21c75c
    Space in bytes the package takes on the system after installation (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: license
Packit Service 21c75c
Packit Service 21c75c
    License of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: medianr
Packit Service 21c75c
Packit Service 21c75c
    Media number for the package (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: name
Packit Service 21c75c
Packit Service 21c75c
    The name of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: obsoletes
Packit Service 21c75c
Packit Service 21c75c
    Packages that are obsoleted by the package (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: provides
Packit Service 21c75c
Packit Service 21c75c
    Package's provides (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: recommends
Packit Service 21c75c
Packit Service 21c75c
    Packages that are recommended by the package (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: release
Packit Service 21c75c
Packit Service 21c75c
    Release of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: reponame
Packit Service 21c75c
Packit Service dd6de2
    Id of repository the package belongs to (@System for installed packages) (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: requires
Packit Service 21c75c
Packit Service 21c75c
    Package's requirements, combined requires_pre and regular_requires (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: requires_pre
Packit Service 21c75c
Packit Service 21c75c
    Installed package's %pre, %post, %preun and %postun requirements (list of Hawkey.Reldep).
Packit Service 21c75c
    For not installed package returns just %pre and $post requirements.
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: regular_requires
Packit Service 21c75c
Packit Service 21c75c
    Package's requirements without %pre, %post, %preun and %postun requirements (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: prereq_ignoreinst
Packit Service 21c75c
Packit Service 21c75c
    Safe to remove requires_pre requirements of an installed package (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: rpmdbid
Packit Service 21c75c
Packit Service 21c75c
    The rpmdb ID for the package (integer).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: source_debug_name
Packit Service 21c75c
Packit Service 21c75c
    The name of the source debug-info package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: source_name
Packit Service 21c75c
Packit Service 21c75c
    The name of the source package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: sourcerpm
Packit Service 21c75c
Packit Service 21c75c
    Full name of the SRPM used to build this package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: suggests
Packit Service 21c75c
Packit Service 21c75c
    Packages that are suggested by the package (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: summary
Packit Service 21c75c
Packit Service 21c75c
    Summary for the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: supplements
Packit Service 21c75c
Packit Service 21c75c
    Packages that the package supplements (list of Hawkey.Reldep).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: url
Packit Service 21c75c
Packit Service 21c75c
    URL for the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. attribute:: version
Packit Service 21c75c
Packit Service 21c75c
    Version of the package (string).
Packit Service 21c75c
Packit Service 21c75c
  .. method:: remote_location(schemes=('http', 'ftp', 'file', 'https'))
Packit Service 21c75c
Packit Service 21c75c
    The location from where the package can be downloaded from (string). If the information is unavailable
Packit Service 21c75c
    it returns ``None``. ``schemes`` limits result to list of protocols.