File Explorer

1# Robust result objects2#3# Copyright (C) 2016 g10 Code GmbH4#5# This file is part of GPGME.6#7# GPGME is free software; you can redistribute it and/or modify it8# under the terms of the GNU Lesser General Public License as9# published by the Free Software Foundation; either version 2.1 of the10# License, or (at your option) any later version.11#12# GPGME is distributed in the hope that it will be useful, but WITHOUT13# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY14# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General15# Public License for more details.16#17# You should have received a copy of the GNU Lesser General Public18# License along with this program; if not, see <https://www.gnu.org/licenses/>.19 20from __future__ import absolute_import, print_function, unicode_literals21del absolute_import, print_function, unicode_literals22"""Robust result objects23 24Results returned by the underlying library are fragile, i.e. they are25only valid until the next operation is performed in the context.26 27We cannot arbitrarily constrain the lifetime of Python objects, we28therefore create deep copies of the results.29 30"""31 32 33class Result(object):34    """Result object35 36    Describes the result of an operation.37 38    """39    """Convert to types"""40    _type = {}41    """Map functions over list attributes"""42    _map = {}43    """Automatically copy unless blacklisted"""44    _blacklist = {45        'acquire',46        'append',47        'disown',48        'next',49        'own',50        'this',51        'thisown',52    }53 54    def __init__(self, fragile):55        for key, func in self._type.items():56            if hasattr(fragile, key):57                setattr(self, key, func(getattr(fragile, key)))58 59        for key, func in self._map.items():60            if hasattr(fragile, key):61                setattr(self, key, list(map(func, getattr(fragile, key))))62 63        for key in dir(fragile):64            if key.startswith('_') or key in self._blacklist:65                continue66            if hasattr(self, key):67                continue68 69            setattr(self, key, getattr(fragile, key))70 71    def __repr__(self):72        return '{}({})'.format(73            self.__class__.__name__,74            ', '.join('{}={!r}'.format(k, getattr(self, k)) for k in dir(self)75                      if not k.startswith('_')))76 77 78class InvalidKey(Result):79    pass80 81 82class EncryptResult(Result):83    _map = dict(invalid_recipients=InvalidKey)84 85 86class Recipient(Result):87    pass88 89 90class DecryptResult(Result):91    _type = dict(wrong_key_usage=bool, is_de_vs=bool)92    _map = dict(recipients=Recipient)93 94 95class NewSignature(Result):96    pass97 98 99class SignResult(Result):100    _map = dict(invalid_signers=InvalidKey, signatures=NewSignature)101 102 103class Notation(Result):104    pass105 106 107class Signature(Result):108    _type = dict(wrong_key_usage=bool, chain_model=bool, is_de_vs=bool)109    _map = dict(notations=Notation)110 111 112class VerifyResult(Result):113    _map = dict(signatures=Signature)114 115 116class ImportStatus(Result):117    pass118 119 120class ImportResult(Result):121    _map = dict(imports=ImportStatus)122 123 124class GenkeyResult(Result):125    _type = dict(primary=bool, sub=bool)126 127 128class KeylistResult(Result):129    _type = dict(truncated=bool)130 131 132class VFSMountResult(Result):133    pass134 135 136class EngineInfo(Result):137    pass138