so the automatic detection # will not be sufficient","self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values","max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars:","jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception):","self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not file.isatty():","import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses","'chrome': os.path.join(appdata_local, R'Google\\Chrome\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\Edge\\User Data'), 'opera':","to decrypt with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return","record_size p.skip_to(record_size, 'space at the end of the record') cookie = compat_cookiejar_Cookie( version=0,","elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else:","self._cookie_counts['other'] += 1 # other prefixes are considered 'old data' which were stored","else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles =","failed_cookies > 0: failed_message = f' ({failed_cookies} could not be decrypted)' else: failed_message","self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False)","None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return","raise NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be","0: failed_message = f' ({failed_cookies} could not be decrypted)' else: failed_message = ''","{sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home()","= _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name =","'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'),","# chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports a flag:","# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN","a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \"\"\" default_wallet = 'kdewallet'","the activate desktop environment [2] Mac: - cookies are either v10 or not","p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a","elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name,","values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return","YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table =","in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME","logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption","by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return","ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key,","'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'),","os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path =","from enum import Enum, auto from hashlib import pbkdf2_hmac from .aes import (","p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except","desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif","printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar()","{len(jar)} cookies from firefox') return jar finally: if cursor is not None: cursor.connection.close()","Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\Edge\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User","'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin'","kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16","{num_bytes} bytes') end = self.cursor + num_bytes if end > len(self._data): raise ParserError('reached","{len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as","not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger)","logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif","'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies database","def read_cstring(self): buffer = [] while True: c = self.read_bytes(1) if c ==","logger=YDLLogger()): \"\"\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of","None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc","is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox')","def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' #","date but the important parts of the database structure is the same -","p = DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return","i += 1 progress_bar.print(f'Searching for \"{filename}\": {i: 6d} files searched') if file ==","not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop","key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key,","generate a random password and store # it, but that doesn't matter here.","elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies are","i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count:","run with the following flags to determine which keyring backend # it has","and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME':","as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not","+= 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger","return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed.","not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None:","self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None:","import os import shutil import struct import subprocess import sys import tempfile from","use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name)","be observed that chromium lists all keys # and presumably searches for its","name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None,","rest={}) class ChromeCookieDecryptor: \"\"\" Overview: Linux: - cookies are either v10 or v11","printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print = lambda","'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None):","= YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table","KeyError: logger.error('no encrypted key in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix","no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] +=","elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif","'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported on","compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):],","{desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring","in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \"{browser_name}\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise","decrypt v10 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger)","organise keys in the same way as KWallet, # using `dbus-monitor` during startup,","the intended behaviour is to generate a random password and store # it,","key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError:","(AES-GCM) because the MAC check failed. Possibly the key is wrong?', only_once=True) return","0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset","encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root,","iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b'","activate desktop environment [2] Mac: - cookies are either v10 or not v10","chrome/chromium can be run with the following flags to determine which keyring backend","could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}')","secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage`","'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config =","various places depending on the activate desktop environment [2] Mac: - cookies are","structure is the same - there are a few bytes here and there","def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser profiles, take the","return item.get_secret() else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring,","= _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox","random password and store # it, but that doesn't matter here. return b''","R'Google\\Chrome\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\Edge\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera","implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in","' 'must be installed to read from KWallet. kwallet-query should be' 'included in","= ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in),","self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version ==","is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False,","'chromium': os.path.join(appdata_local, R'Chromium\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\Edge\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'),","except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name,","logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path,","with DPAPI - not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ -","*, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform","expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar","is chosen, all cookies are stored as v10 (so no keyring password is","appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\Brave-Browser\\User Data'),","def read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0]","nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext","find local state file') return None logger.debug(f'Found local state file at \"{path}\"') with","'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile","= data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes","def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc","KDE because chrome does not check hasEntry and instead # just tries to","'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium',","raise ValueError(f'unsupported browser: \"{browser_name}\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring:","end > len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor =","return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open","the database structure is the same - there are a few bytes here","name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies =","jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar:","cookies from safari') return jar class ParserError(Exception): pass class DataParser: def __init__(self, data,","desktop environment [2] Mac: - cookies are either v10 or not v10 -","auto() class _LinuxKeyring(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \"\"\" KWALLET = auto() GNOMEKEYRING = auto()","3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain","parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception): pass class","version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10","function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \"\"\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session',","key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 //","for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \"\"\"","== filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda path:","def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown","DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in","logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum):","be stored in various places depending on the activate desktop environment [2] Mac:","between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def","# match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout,","read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def","logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local","0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid","NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented","encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None","if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies database in \"{search_root}\"')","logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring ==","Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could","{sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path =","'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera':","using `dbus-monitor` during startup, it can be observed that chromium lists all keys","return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if","are either v10 or v11 - v10: AES-CBC encrypted with a fixed key","import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext)","_get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen, all","to generate a random password and store # it, but that doesn't matter","progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar,","None: raise FileNotFoundError(f'could not find {browser_name} cookies database in \"{search_root}\"') logger.debug(f'Extracting cookies from:","sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger)","'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill()","the MAC check failed. Possibly the key is wrong?', only_once=True) return None try:","'-w', # write password to stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name}","authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1","# pDataIn None, # ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy:","as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset,","key in the list. It appears that we must do the same. #","and store # it, but that doesn't matter here. return b'' else: logger.debug('password","auto() CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON = auto()","KWallet and kwallet-query ' 'must be installed to read from KWallet. kwallet-query should","elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif","It appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as","end return data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value !=","from firefox without sqlite3 support. ' 'Please use a python interpreter compiled with","sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles') elif","16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to","0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset -","v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length","_get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys',","intended behaviour is to generate a random password and store # it, but","_LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return","_extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS:","only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 #","running `python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False","= encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None:","= cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i:","None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform","starting chrome. # this may be a bug as the intended behaviour is","'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar =","= 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0: raise","self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is","{error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}')","sys import tempfile from datetime import datetime, timedelta, timezone from enum import Enum,","= None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry,","obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password","if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config,","'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles","= not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is","return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path","return b'' # the Gnome keyring does not seem to organise keys in","buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData(","does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path",") if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None result","_LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \"\"\" The name of the wallet used to","domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return","MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE","cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return","None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is","else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is","= jar.filename return output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None,","GNOME = auto() KDE = auto() PANTHEON = auto() UNITY = auto() XFCE","{proc.returncode}. Please consult ' 'the kwallet-query man page for details') return b'' else:","b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage',","were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root,","xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop","> len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end","cookies from: \"{cookie_database_path}\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir:","page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h","this may be a bug as the intended behaviour is to generate a","b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no","config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root =","v10 (so no keyring password is required) return None assert False, f'Unknown keyring","col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage':","if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \"{browser_name}\"') if keyring not in","_LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \"\"\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session =","os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User Data'), }[browser_name] elif sys.platform == 'darwin':","return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return","Windows: - cookies are either v10 or not v10 - v10: AES-GCM encrypted","# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger","record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \"\"\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears","p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding failed', only_once=True)","from kwallet. Using empty string instead') # this sometimes occurs in KDE because","cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}')","than linux - not v10: 'old data' stored as plaintext Windows: - cookies","- [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \"\"\" def decrypt(self, encrypted_value): raise","p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring()","because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None def","== _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif","def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for cookie in jar:","= auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env):","try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State') return","determined by snooping on dbus while opening the browser in KDE: # dbus-monitor","is None: logger.error('could not find local state file') return None logger.debug(f'Found local state","else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \"\"\" The name of the","'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\Brave-Browser\\User","`secretstorage` module is not installed. ' 'Please install by running `python3 -m pip","= 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for",".aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from","encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key","( 'as the `secretstorage` module is not installed. ' 'Please install by running","{num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'):","which keyring backend # it has chosen to use # chromium --enable-logging=stderr --v=1","try: if not file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print","json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State')","for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query',","(which kwallet returns \"\") whereas kwallet-query # checks hasEntry. To verify this: #","_is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite',","= _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring()","jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for","logger.debug(f'a cookies page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page","0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database","return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because","not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \"{keyring}\"') if profile is not None","'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'),","as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using","return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform","tempfile from datetime import datetime, timedelta, timezone from enum import Enum, auto from","_LinuxKeyring(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \"\"\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT =","message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value} !=","else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): #","not v10 - v10: AES-GCM encrypted with a key which is encrypted with","}[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be determined","None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 # boringssl #","the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item","its key in the list. It appears that we must do the same.","return record_size p.skip_to(record_size, 'space at the end of the record') cookie = compat_cookiejar_Cookie(","browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring)","expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value:","encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None","os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for \"{filename}\": {i: 6d}","value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser:","or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return","an OS protected key (keyring) and more key derivation iterations than linux -","read'): logger.debug('failed to read password from kwallet. Using empty string instead') # this","or v11 - v10: AES-CBC encrypted with a fixed key - v11: AES-CBC","for file in files: i += 1 progress_bar.print(f'Searching for \"{filename}\": {i: 6d} files","version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False,","return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True: c = self.read_bytes(1)","= DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar","flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not be sufficient in all","encrypted with an OS protected key (keyring) and more key derivation iterations than","# pPromptStruct: information about prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut","return code {proc.returncode}. Please consult ' 'the kwallet-query man page for details') return","'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon':","c = self.read_bytes(1) if c == b'\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self,","config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor =","self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self,","Wallet::NetworkWallet \"\"\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5',","*line) if not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies +=","b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet. Using","cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8')","{i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if","if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies database in {search_root}')","isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall()","return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop","not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path =","len(table) for i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie","= {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from","depending on the activate desktop environment [2] Mac: - cookies are either v10","import struct import subprocess import sys import tempfile from datetime import datetime, timedelta,","logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without","plaintext Windows: - cookies are either v10 or not v10 - v10: AES-GCM","Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if","elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif","= self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value, message): value =","= proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please","e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE:","warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message)","jar finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value,","big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if","= _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure'","running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not","raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end return data","is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:],","will not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else","{value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else","is required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using","import datetime, timedelta, timezone from enum import Enum, auto from hashlib import pbkdf2_hmac","if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc,","message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer =","sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave':","out of date but the important parts of the database structure is the","Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User Data'), }[browser_name] elif sys.platform","{'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message):","\"\") whereas kwallet-query # checks hasEntry. To verify this: # dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\"","self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key,","domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value","Possibly the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag,","( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import","finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value,","= 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag =","be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen","stdout[-1:] == b'\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception","else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password):","keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key","find {browser_name} cookies database in \"{search_root}\"') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') decryptor = get_cookie_decryptor(config['browser_dir'],","if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar()","only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext,","browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)","multiple browser profiles, take the most recently used one i, paths = 0,","are skipped during parsing \"\"\" if jar is None: jar = YoutubeDLCookieJar() page_sizes,","the standard library, it is possible to compile python without # sqlite support.","if xdg_current_desktop == 'Unity': if desktop_session is not None and 'gnome-fallback' in desktop_session:","value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None,","required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password","in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name,","class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger)","state file') return None logger.debug(f'Found local state file at \"{path}\"') with open(path, encoding='utf8')","os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application","dirs, files in os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for","References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date but","appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con:","either v10 or v11 - v10: AES-CBC encrypted with a fixed key -","def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with the following","logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to","return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class","= ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description of pDataIn","AES-CBC encrypted with an OS protected key (keyring) and more key derivation iterations","support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies')","- cookies are either v10 or not v10 - v10: AES-GCM encrypted with","'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi'","name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None,","'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE':","None: raise FileNotFoundError(f'could not find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from:","network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def","when basic text is chosen, all cookies are stored as v10 (so no","path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None,","end = self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end of","as f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted","ImportError: # although sqlite3 is part of the standard library, it is possible","and kwallet-query ' 'must be installed to read from KWallet. kwallet-query should be'","= auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment","version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11","logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name}","- not v10: 'old data' stored as plaintext Windows: - cookies are either","self.read_bytes(1) if c == b'\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'):","and more key derivation iterations than linux - not v10: 'old data' stored","check hasEntry and instead # just tries to read the value (which kwallet","man page for details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to","for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page of size","profile is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root","in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles') elif sys.platform","'included in the kwallet package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger)","can be stored in various places depending on the activate desktop environment [2]","logger): \"\"\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \"\"\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_","for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie =","raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None):","range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00',","if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must","in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename","DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, #","in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID'","p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) #","UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext,","cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return","total_cookie_count = len(table) for i, (host, name, value, path, expiry, is_secure) in enumerate(table):","# the Gnome keyring does not seem to organise keys in the same","key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because","python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root","while starting chrome. # this may be a bug as the intended behaviour","proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip()","_LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return","return None def _decrypt_windows_dpapi(ciphertext, logger): \"\"\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \"\"\" from ctypes.wintypes import","Possibly the key is wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError:","size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger)","elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif","as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table):","cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count:","ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key,","found. KWallet and kwallet-query ' 'must be installed to read from KWallet. kwallet-query","encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif","b'\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query:","6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path,","os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else:","See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError:","read_cstring(self): buffer = [] while True: c = self.read_bytes(1) if c == b'\\x00':","https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date but the important","is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name,","return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return","logger.debug(f'NetworkWallet = \"{network_wallet}\"') return network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet:","== 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop ==","interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is","import json import os import shutil import struct import subprocess import sys import","[] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root): for file","('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles') elif sys.platform ==","that chromium lists all keys # and presumably searches for its key in","installed. ' 'Please install by running `python3 -m pip install secretstorage`.') except Exception","'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'}","python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile","be a bug as the intended behaviour is to generate a random password","# if there are multiple browser profiles, take the most recently used one","key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for","browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\Brave-Browser\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\Chrome\\User Data'), 'chromium': os.path.join(appdata_local,","if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name,","logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger)","logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key is","wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \"\"\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \"\"\" from","are either v10 or not v10 - v10: AES-GCM encrypted with a key","and presumably searches for its key in the list. It appears that we","{'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class","'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages')","' 'Please install by running `python3 -m pip install secretstorage`.') except Exception as","interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root =","'--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode","def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they are already in","not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support. ' 'Please use","'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif","logger): logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query","'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform ==","_open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if","{expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return","https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \"\"\" OTHER = auto() CINNAMON = auto() GNOME = auto() KDE","datetime, timedelta, timezone from enum import Enum, auto from hashlib import pbkdf2_hmac from","_create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer printer =","while opening the browser in KDE: # dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\" keyring_name = {","_LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc","bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else","if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile,","f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if","'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir","'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session:","auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \"\"\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP',","== 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi':","jar class ParserError(Exception): pass class DataParser: def __init__(self, data, logger): self._data = data","of date but the important parts of the database structure is the same","num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes') end =","return printer printer = QuietMultilinePrinter() printer.print = lambda _: None return printer def","{i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host),","def __init__(self, data, logger): self._data = data self.cursor = 0 self._logger = logger","= os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile)","1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password","not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie)","bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset =","is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \"\"\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \"\"\"","= _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name}","if profile is not None and _is_path(profile): profile = os.path.expanduser(profile) return browser_name, profile,","}[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave':","table = cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie","== 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported","jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return output_jar def","grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection #","used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to","[] if browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile,","string instead') # this sometimes occurs in KDE because chrome does not check","= _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root =","encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext,","= secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return","sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium',","= Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE,","'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera':","b'' # the Gnome keyring does not seem to organise keys in the","CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def","not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts","occurs in KDE because chrome does not check hasEntry and instead # just","ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved:","is None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be installed","is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint()","'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies","2>&1 | grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic","'Local State', logger) if path is None: logger.error('could not find local state file')","buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr:","pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must be NULL None, #","table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root,","continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message","authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other prefix means the data","with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root","UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext,","pDataIn None, # ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy: salt?","+= 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies >","if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name,","os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi':","or not v10 - v10: AES-CBC encrypted with an OS protected key (keyring)","has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar:","(e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path)","_extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from","= auto() XFCE = auto() class _LinuxKeyring(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \"\"\" KWALLET =","DPAPI - not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2]","def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data,","logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure","to decrypt cookie (AES-GCM) because the MAC check failed. Possibly the key is","(AES-GCM) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None","'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name","= '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer =","platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path","cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *,","is_encrypted = not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value","more key derivation iterations than linux - not v10: 'old data' stored as","'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be","[1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \"\"\" def decrypt(self, encrypted_value): raise NotImplementedError('Must","domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted","return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari does","= p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double())","xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not None and","elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session","with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory","env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger):","has chosen to use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ #","auto() PANTHEON = auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \"\"\"","except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger):","None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path,","return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding failed.","return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring ==","_get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc =","None def _decrypt_windows_dpapi(ciphertext, logger): \"\"\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \"\"\" from ctypes.wintypes import DWORD","DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer),","def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl:","result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def","column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else 'secure'","keys can be stored in various places depending on the activate desktop environment","file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message:","a print method. (Optional)\"\"\" # Do not print to files/pipes, loggers, or when","= auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend","os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported","import subprocess import sys import tempfile from datetime import datetime, timedelta, timezone from","path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data,","file)) return None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars):","= f'as the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave',","elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME","desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in","not found. KWallet and kwallet-query ' 'must be installed to read from KWallet.","return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to","None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8","proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout,","timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages =","raise NotImplementedError(f'Chrome cookie decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor):","\"\"\" if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger)","if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir':","stored as v10 (so no keyring password is required) return None assert False,","on dbus while opening the browser in KDE: # dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\" keyring_name","= 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext =","in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser profiles,","p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size","tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host,","code {proc.returncode}. Please consult ' 'the kwallet-query man page for details') return b''","found') if stdout[-1:] == b'\\n': stdout = stdout[:-1] return stdout except Exception as","AES-CBC encrypted with an OS protected key (keyring) - v11 keys can be","else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if","True: c = self.read_bytes(1) if c == b'\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def","= YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for","from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support.","the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus","- cookies are either v10 or v11 - v10: AES-CBC encrypted with a","[2] Mac: - cookies are either v10 or not v10 - v10: AES-CBC","def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not","platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger","# match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\n':","'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md","jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table)","logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version","open(cookies_path, 'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)}","browser: \"{browser_name}\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \"{keyring}\"') if","# kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length =","page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in page_sizes:","debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def","'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>',","None, # pOptionalEntropy: salt? None, # pvReserved: must be NULL None, # pPromptStruct:","except ImportError: # although sqlite3 is part of the standard library, it is","derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def","encrypted with a key which is encrypted with DPAPI - not v10: encrypted","{ 'brave': os.path.join(appdata_local, R'BraveSoftware\\Brave-Browser\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\Chrome\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\User Data'),","the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium',","# boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length]","_get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could","not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb') as","port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie)","self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc #","else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if","unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table)","auto() GNOME = auto() KDE = auto() PANTHEON = auto() UNITY = auto()","def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies","\"{browser_name}\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \"{keyring}\"') if profile","ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description of","'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return","although sqlite3 is part of the standard library, it is possible to compile","logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in","sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not","try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM","there which are skipped during parsing \"\"\" if jar is None: jar =","encrypted key in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI'","return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return","_LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring","NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \"{network_wallet}\"') return network_wallet except","cookies are either v10 or v11 - v10: AES-CBC encrypted with a fixed","logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment","must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con)","f' ({failed_cookies} could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies","SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl =","shutil import struct import subprocess import sys import tempfile from datetime import datetime,","elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset,","cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies')","decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name,","return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in ('mate', 'gnome'): return","'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def","1 # other prefixes are considered 'old data' which were stored as plaintext","not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS","message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def","SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE =","if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else","password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0}","= os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name):","contextlib import ctypes import json import os import shutil import struct import subprocess","None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in value def","= _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger):","!= expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format","def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10':","browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger)","skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def","desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if","DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class","{browser_name} cookies database in \"{search_root}\"') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'],","encrypted with DPAPI - not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/","= p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure = bool(flags","and there which are skipped during parsing \"\"\" if jar is None: jar","searches for its key in the list. It appears that we must do","they are already in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite')","OTHER = auto() CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON","in files: i += 1 progress_bar.print(f'Searching for \"{filename}\": {i: 6d} files searched') if","logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies database in","def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:]","struct import subprocess import sys import tempfile from datetime import datetime, timedelta, timezone","find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as","'edge': os.path.join(appdata_local, R'Microsoft\\Edge\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User Data'),","proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ],","page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00', 'page signature')","value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie(","hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print","'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \"\"\"","not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *,","UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key","jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename =","on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger","os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}')","- this data appears to be out of date but the important parts","boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext","1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger)","implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented by sub","_mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring()","does a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \"\"\" default_wallet =","progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading","_LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring","here and there which are skipped during parsing \"\"\" if jar is None:","if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0:","auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \"\"\"","fixed key - v11: AES-CBC encrypted with an OS protected key (keyring) -","sometimes occurs in KDE because chrome does not check hasEntry and instead #","1 progress_bar.print(f'Searching for \"{filename}\": {i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root,","= _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config,","== f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read from keyring') return","None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger)","config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'],","os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux","_decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try:","self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end of input') data","decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger):","None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt,","= DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for","def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name","hasEntry. To verify this: # dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\" # while starting chrome. #","of {num_bytes} bytes') end = self.cursor + num_bytes if end > len(self._data): raise","_choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring","'unknown record field 1') flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4,","be determined by snooping on dbus while opening the browser in KDE: #","because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end of","plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger =","progress_bar: for curr_root, dirs, files in os.walk(root): for file in files: i +=","name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value","`dbus-monitor` during startup, it can be observed that chromium lists all keys #","return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome","= '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format","{len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown:","try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie","if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult '","for row in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple","to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try:","search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles']","load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is not None: browser_name, profile,","not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not","pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as","key (keyring) - v11 keys can be stored in various places depending on","\"\"\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys()","not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not seem to","comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \"\"\" Overview: Linux: - cookies are either v10","if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if","Enum, auto from hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7,","return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value):","with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \"\"\" def","b'\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running find-generic-password:","password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and","from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support.","import sys import tempfile from datetime import datetime, timedelta, timezone from enum import","be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts =","not None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in value","= _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self): return","ctypes import json import os import shutil import struct import subprocess import sys","SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part of the standard","value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None,","not v10 - v10: AES-CBC encrypted with an OS protected key (keyring) and","CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON = auto() UNITY","value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None,","is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue elif","in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length =","'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring","self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001,","path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table","comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if","= [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger):","logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could not","decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name,","breakdown: {counts}') return jar finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor,","comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if cursor",".minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import","authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag","= raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 #","in ('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome':","'--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if","logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not seem","on the activate desktop environment [2] Mac: - cookies are either v10 or","to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key is wrong?',","https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \"\"\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS","= {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm","stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b''","are a few bytes here and there which are skipped during parsing \"\"\"","0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to decrypt","'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not","chosen, all cookies are stored as v10 (so no keyring password is required)","if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt,","decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy()","decrypt v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength","a few bytes here and there which are skipped during parsing \"\"\" if","self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1,","p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa:","value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding","from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query","value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and encrypted_value if","elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def","None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor):","# this may be a bug as the intended behaviour is to generate","'-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill()","display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to","if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring","return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d'","keyring: \"{keyring}\"') if profile is not None and _is_path(profile): profile = os.path.expanduser(profile) return","in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return output_jar","__init__(self, data, logger): self._data = data self.cursor = 0 self._logger = logger def","= raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag,","== b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies:","for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p =","= p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed","with a key which is encrypted with DPAPI - not v10: encrypted with","decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end of the record')","None: logger.error('safari does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform:","cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in","# EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext =","with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif","= '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies","pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key,","kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query '","to read from KWallet. kwallet-query should be' 'included in the kwallet package for","YoutubeDLCookieJar() for jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is","= { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform","find safari cookies database') with open(cookies_path, 'rb') as f: cookies_data = f.read() jar","DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _","== 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name]","if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return","R'Microsoft\\Edge\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User Data'), }[browser_name] elif","we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col =","human readable description of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must","--no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file =","progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie:","key derivation iterations than linux - not v10: 'old data' stored as plaintext","+= 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no key found',","in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment","- cookies are either v10 or not v10 - v10: AES-CBC encrypted with","os import shutil import struct import subprocess import sys import tempfile from datetime","is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password):","'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE':","_find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could not find local state","record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length","*, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger)","if cookie_file is not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file,","is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error']","class _LinuxDesktopEnvironment(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \"\"\" OTHER = auto() CINNAMON = auto() GNOME","if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet. Using empty string","that doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:] == b'\\n':","return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env:","logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc = Popen(","network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \"{network_wallet}\"') return network_wallet except Exception as e: logger.warning(f'exception","logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as","sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'):","= decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if","from: \"{cookie_database_path}\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path,","name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie","decrypt v11 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger)","expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format =","\"\"\" Overview: Linux: - cookies are either v10 or v11 - v10: AES-CBC","so the automatic detection # will not be sufficient in all cases. keyring","ydl=None): self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message):","def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property",".compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen,","name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and encrypted_value","def __init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key =","browser_specification, ydl): cookie_jars = [] if browser_specification is not None: browser_name, profile, keyring","salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version =","desktop_session is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY","logger): # if there are multiple browser profiles, take the most recently used","Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:]","return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger):",".utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except","R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata","= auto() KDE = auto() PANTHEON = auto() UNITY = auto() XFCE =","ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if","if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin':","https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \"\"\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment ==","-m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON =","domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size","record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset","jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if cursor is not","counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor is","config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not","names can be determined by snooping on dbus while opening the browser in","_LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \"\"\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected","def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir","return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \"{network_wallet}\"') return network_wallet except Exception","browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \"{browser_name}\"') if keyring not in (None,","_config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'),","'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata,","decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True)","if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring =","('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config,","self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if","v10: 'old data' stored as plaintext Windows: - cookies are either v10 or","browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}')","ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config","ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE:","import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar,","WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts","logger.debug(f'Found local state file at \"{path}\"') with open(path, encoding='utf8') as f: data =","\"type=method_return\" # while starting chrome. # this may be a bug as the","install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the","0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count =","else: self._cookie_counts['other'] += 1 # any other prefix means the data is DPAPI","{sys.platform}') # Linux keyring names can be determined by snooping on dbus while","LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform ==","None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name,","read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes') end","def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected","# pDataOut ) if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return","instead # just tries to read the value (which kwallet returns \"\") whereas","< 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset","in \"{search_root}\"') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with","cookies database in \"{search_root}\"') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger,","end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain,","to be out of date but the important parts of the database structure","F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path =","p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True)","the important parts of the database structure is the same - there are","'must be installed to read from KWallet. kwallet-query should be' 'included in the","elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when","= [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page","QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE =","= os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path","self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger =","= _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET:","= auto() class _LinuxKeyring(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \"\"\" KWALLET = auto() GNOMEKEYRING =","else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in","v10: AES-CBC encrypted with a fixed key - v11: AES-CBC encrypted with an","logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage","for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else:","shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be","key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1","is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure,","p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset =","version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version ==","logger.error('could not find local state file') return None logger.debug(f'Found local state file at","UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \"\"\" KWALLET","try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part","a context manager with a print method. (Optional)\"\"\" # Do not print to","sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path):","os.path.join(appdata_local, R'BraveSoftware\\Brave-Browser\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\Chrome\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\User Data'), 'edge': os.path.join(appdata_local,","logger): p = DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets =","Popen( ['security', 'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name, # match","\"\"\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))]","that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col","BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \"\"\" xdg_current_desktop","a bug as the intended behaviour is to generate a random password and","cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari","SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not be initialized.","return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password =","_find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies","return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping","return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar: for i, record_offset","os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can","domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def","jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \"\"\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this","'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return","with _create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies:","_LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop ==","list. It appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init())","https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \"\"\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be","elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring","password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is None else","QuietMultilinePrinter() printer.print = lambda _: None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars","= False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not installed. '","host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies","logger): self._data = data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes):","= _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name}","is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif","else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar","'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout,","import shutil import struct import subprocess import sys import tempfile from datetime import","pass class DataParser: def __init__(self, data, logger): self._data = data self.cursor = 0","def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \"\"\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to","= None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor,","platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config =","'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if","store # it, but that doesn't matter here. return b'' else: logger.debug('password found')","to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \"{network_wallet}\"') return","number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)} has no cookies') return","16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:]","files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths","'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary","def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name,","* 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed","filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime)","if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version","'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>',","1 # any other prefix means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc","import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = (","def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is","can be run with the following flags to determine which keyring backend #","paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in","+= 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no key found',","'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local =","startup, it can be observed that chromium lists all keys # and presumably","it, but that doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:]","path.decode('utf-8') is_encrypted = not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if","AES-GCM encrypted with a key which is encrypted with DPAPI - not v10:","library, it is possible to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544","logger): if profile is not None: logger.error('safari does not support profiles') if sys.platform","'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message): if","'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local","password from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', # write","self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read","return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password,","from firefox') return jar finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir():","cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path,","but the important parts of the database structure is the same - there","database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor,","in {search_root}') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None","cookies are either v10 or not v10 - v10: AES-CBC encrypted with an","running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State',","desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment ==","pDataOut ) if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None","could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'}","elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser:","'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name, # match 'account' '-s',","as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name,","linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \"\"\" The","return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \"\"\"","os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they are","os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\Brave-Browser\\User Data'), 'chrome': os.path.join(appdata_local,","linux - not v10: 'old data' stored as plaintext Windows: - cookies are","as plaintext Windows: - cookies are either v10 or not v10 - v10:","for details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password","elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = {","data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes <","bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data),","for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between","keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir)","loggers, or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'):","return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return","v10 or not v10 - v10: AES-GCM encrypted with a key which is","if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod","record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar,","and instead # just tries to read the value (which kwallet returns \"\")","to obtain password from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w',","the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger):","if failed_cookies > 0: failed_message = f' ({failed_cookies} could not be decrypted)' else:","{'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from #","return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME',","# checks hasEntry. To verify this: # dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\" # while starting","import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part of","during parsing \"\"\" if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start =","if not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1","the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \"\"\" References: -","= logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None","it can be observed that chromium lists all keys # and presumably searches","if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support. ' 'Please","not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path","only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \"\"\"Return a context manager","value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value}","stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code","def _get_kwallet_network_wallet(logger): \"\"\" The name of the wallet used to store network passwords.","_LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE","files/pipes, loggers, or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or","print to files/pipes, loggers, or when --no-progress is used if not self._ydl or","encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies","return linux_keyring def _get_kwallet_network_wallet(logger): \"\"\" The name of the wallet used to store","linux_keyring def _get_kwallet_network_wallet(logger): \"\"\" The name of the wallet used to store network","p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data,","path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from","KDE: # dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium':","raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie","self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key,","field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset =","blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn","== _LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies are stored as","_extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract","paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar","if value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self,","file in files: i += 1 progress_bar.print(f'Searching for \"{filename}\": {i: 6d} files searched')","for i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i:","sqlite databases if they are already in use (e.g. by the browser) database_copy_path","and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted,","cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue elif not","= _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is None else self.derive_key(password)","Safe Storage': return item.get_secret() else: logger.error('failed to read from keyring') return b'' def","import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError:","f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX","({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return struct.unpack(data_format,","detection # will not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if","profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if","jar finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in","pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version","is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f' ({failed_cookies}","return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in","a flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not be sufficient in","cookies from firefox') return jar finally: if cursor is not None: cursor.connection.close() def","subprocess import sys import tempfile from datetime import datetime, timedelta, timezone from enum","data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if","DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint()","stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\n': stdout = stdout[:-1] return stdout except","'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile,","except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is","browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not","jar.filename is not None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep","_find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies","if number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)} has no cookies')","p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger)","= encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger)","else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif","info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message,","cannot open sqlite databases if they are already in use (e.g. by the","_merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for cookie in jar: output_jar.set_cookie(cookie)","self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from","kwallet-query ' 'must be installed to read from KWallet. kwallet-query should be' 'included","Gnome keyring does not seem to organise keys in the same way as","big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True:","match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\n': stdout","if c == b'\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if","cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc,","ValueError(f'unsupported browser: \"{browser_name}\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \"{keyring}\"')","plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt","found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 #","raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger)","same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item in","__init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password =","raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] +=","def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts =","secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find","tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory =","from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', # write password","are already in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path,","6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if not","environment [2] Mac: - cookies are either v10 or not v10 - v10:","def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00', 'page signature') number_of_cookies =","- https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date but the","not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not","= proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet else:","_LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME","if file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths,","return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other","the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'),","empty string instead') # this sometimes occurs in KDE because chrome does not","a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if","with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, (host,","compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc,","= config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else","{ 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'),","version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1","big_endian=False): data_format = '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self):","'old data' stored as plaintext Windows: - cookies are either v10 or not","Storage': return item.get_secret() else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name,","cookies database') with open(cookies_path, 'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data,","port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={})","protected key (keyring) - v11 keys can be stored in various places depending","YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif _is_path(profile):","KWallet, # using `dbus-monitor` during startup, it can be observed that chromium lists","a fixed key - v11: AES-CBC encrypted with an OS protected key (keyring)","standard library, it is possible to compile python without # sqlite support. See:","'' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie","xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session","p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8","os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%')","is None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None return","& 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint()","col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read","prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret:","profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name","= 'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value,","self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0}","flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field 2')","is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is","stdout except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root,","install by running `python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE","(keyring) and more key derivation iterations than linux - not v10: 'old data'","if stdout[-1:] == b'\\n': stdout = stdout[:-1] return stdout except Exception as e:","secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return","line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line)","keyring password is required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name,","__init__(self, ydl=None): self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self,","= get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try:","'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name]","with an OS protected key (keyring) and more key derivation iterations than linux","None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies')","cookie decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self,","({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def","= DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable","# dbus-monitor \"interface='org.kde.KWallet'\" \"type=method_return\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium',","'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER","= {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles","def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}')","p.skip_to(record_size, 'space at the end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name,","doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:] == b'\\n': stdout","value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar:","key (keyring) and more key derivation iterations than linux - not v10: 'old","} def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE:","= stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return","name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError:","= DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None,","Linux keyring names can be determined by snooping on dbus while opening the","p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00', 'page signature') number_of_cookies","cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies","chosen to use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium","not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise","0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet =","proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult","ValueError(f'unsupported keyring: \"{keyring}\"') if profile is not None and _is_path(profile): profile = os.path.expanduser(profile)","ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end return data def","Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill()","KDE = auto() PANTHEON = auto() UNITY = auto() XFCE = auto() class","cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring","_create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root): for file in files:","class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message): if self._ydl:","files in os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for \"{filename}\":","return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is not","= expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars)","if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles')","num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes","self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \"\"\"Return a","output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name,","datetime import datetime, timedelta, timezone from enum import Enum, auto from hashlib import","_decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except","OS protected key (keyring) - v11 keys can be stored in various places","None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop ==","'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'),","{search_root}') logger.debug(f'Extracting cookies from: \"{cookie_database_path}\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try:","decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None","path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie(","return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key =","logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes =","host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not","as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger","'the kwallet-query man page for details') return b'' else: if stdout.lower().startswith(b'failed to read'):","{'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return","profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] =","no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] +=","without sqlite3 support. ' 'Please use a python interpreter compiled with sqlite3 support')","with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line","logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be installed to read","browser profiles, take the most recently used one i, paths = 0, []","logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc = Popen( ['security',","logger.debug('failed to read password from kwallet. Using empty string instead') # this sometimes","jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None:","profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies","= _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \"\"\" The name","tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar()","ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is","logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command","_get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with the following flags","is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod","cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names =","for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename","cookie_jars = [] if browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification)","row in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser","{browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract","'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform","information about prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if","else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be determined by","(None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \"{keyring}\"') if profile is not None and _is_path(profile):","cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with","profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None:","either v10 or not v10 - v10: AES-CBC encrypted with an OS protected","= auto() GNOME = auto() KDE = auto() PANTHEON = auto() UNITY =","comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \"\"\" References: -","v10 - v10: AES-GCM encrypted with a key which is encrypted with DPAPI","stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger):","logger.error('safari does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}')","SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not installed. ' 'Please install","'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\Mozilla\\Firefox\\Profiles') elif sys.platform == 'darwin':","_parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \"\"\" OTHER","= auto() CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON =","page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \"\"\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \"\"\"","'progress_bar'): printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print =","' 'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config","the `secretstorage` module is not installed. ' 'Please install by running `python3 -m","Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0:","extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif","else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not","expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def","e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root,","name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None,","class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key =","one i, paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs,","name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as","record field 1') flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown","with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT","6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue","], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed","return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other prefixes are considered","\"interface='org.kde.KWallet'\" \"type=method_return\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft","env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop ==","_LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON","by running `python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE =","profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file = expand_path(cookie_file) jar =","= xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not None and 'gnome-fallback'","'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return","store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to the following","def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes')","buffer = [] while True: c = self.read_bytes(1) if c == b'\\x00': return","None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0,","96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext","raise FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb') as f: cookies_data","bytes') end = self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end","Safari cookie because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the","ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir):","def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger)","R'BraveSoftware\\Brave-Browser\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\Chrome\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\Edge\\User","== 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else:","there are a few bytes here and there which are skipped during parsing","xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session","= DataParser(data, logger) p.expect_bytes(b'\\x00\\x00\\x01\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for","raise ValueError(f'unsupported keyring: \"{keyring}\"') if profile is not None and _is_path(profile): profile =","logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name ==","sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root =","{self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self,","YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in","note: chrome/chromium can be run with the following flags to determine which keyring","file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda","FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger)","self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from #","'space at the end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value,","just tries to read the value (which kwallet returns \"\") whereas kwallet-query #","timezone from enum import Enum, auto from hashlib import pbkdf2_hmac from .aes import","logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note:","local state file at \"{path}\"') with open(path, encoding='utf8') as f: data = json.load(f)","b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with the","keyring does not seem to organise keys in the same way as KWallet,","support. ' 'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar()","os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata,","encrypted with an OS protected key (keyring) - v11 keys can be stored","the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor()","input') data = self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value, message):","logger): # note: chrome/chromium can be run with the following flags to determine","expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is","sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif _is_path(profile):","os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%')","profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None:","'opera': os.path.join(appdata_roaming, R'Opera Software\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\User Data'), }[browser_name] elif sys.platform ==","expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0","\"\"\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not","{browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar","page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field')","sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name):","= f' ({failed_cookies} could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)}","assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password","package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([","the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \"\"\" default_wallet = 'kdewallet' try: proc = Popen([","logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor is not None: cursor.connection.close()","printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger,","used one i, paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root,","as v10 (so no keyring password is required) return None assert False, f'Unknown","# Linux keyring names can be determined by snooping on dbus while opening","f'as the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome',","jar=None, logger=YDLLogger()): \"\"\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out","if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message,","from KWallet. kwallet-query should be' 'included in the kwallet package for your distribution')","password is required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger):","cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if"],"string":"[\n \"= compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure,\",\n \"--enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so\",\n \"e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query\",\n \"= self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end of input')\",\n \"state file at \\\"{path}\\\"') with open(path, encoding='utf8') as f: data = json.load(f) try:\",\n \"extract cookies from {browser_name} without sqlite3 support. ' 'Please use a python interpreter\",\n \"tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value,\",\n \"UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end of the\",\n \"data, logger): self._data = data self.cursor = 0 self._logger = logger def read_bytes(self,\",\n \"[row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are\",\n \"{len(jar)} cookies from safari') return jar class ParserError(Exception): pass class DataParser: def __init__(self,\",\n \"elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend\",\n \"tries to read the value (which kwallet returns \\\"\\\") whereas kwallet-query # checks\",\n \"discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References:\",\n \"search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir']\",\n \"is to generate a random password and store # it, but that doesn't\",\n \"= env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop\",\n \"= ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl:\",\n \"consult ' 'the kwallet-query man page for details') return b'' else: if stdout.lower().startswith(b'failed\",\n \"Using empty string instead') # this sometimes occurs in KDE because chrome does\",\n \"'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name\",\n \"self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False):\",\n \"1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True)\",\n \"if cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'):\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari\",\n \"0: raise ParserError(f'invalid read of {num_bytes} bytes') end = self.cursor + num_bytes if\",\n \"_parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger)\",\n \"parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be\",\n \"OS protected key (keyring) and more key derivation iterations than linux - not\",\n \"https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if\",\n \"'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl\",\n \"lambda _: None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if\",\n \"b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11']\",\n \"key which is encrypted with DPAPI - not v10: encrypted with DPAPI Sources:\",\n \"decrypt cookie (AES-GCM) because the MAC check failed. Possibly the key is wrong?',\",\n \"*, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari':\",\n \"return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from kwallet') if\",\n \"pPromptStruct: information about prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut )\",\n \"return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations,\",\n \"proc = Popen( ['security', 'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name,\",\n \"// 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce\",\n \"are either v10 or not v10 - v10: AES-CBC encrypted with an OS\",\n \"records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data,\",\n \"self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self):\",\n \"'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming\",\n \"p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between\",\n \"def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce)\",\n \"return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet.\",\n \"else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles':\",\n \"(AES-CBC) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None\",\n \"the same way as KWallet, # using `dbus-monitor` during startup, it can be\",\n \"in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome',\",\n \"raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any\",\n \"not find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp')\",\n \"which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self,\",\n \"ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies]\",\n \"in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM\",\n \"port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class\",\n \"+= 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched') if file == filename:\",\n \"'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout =\",\n \"expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value}\",\n \"--password-store=<basic|gnome|kwallet> so the automatic detection # will not be sufficient in all cases.\",\n \"value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0\",\n \"elif version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt\",\n \"ydl): cookie_jars = [] if browser_specification is not None: browser_name, profile, keyring =\",\n \"None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain\",\n \"self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException: return\",\n \"stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout\",\n \"domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8,\",\n \"if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return\",\n \"raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor,\",\n \"= unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie\",\n \"'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self,\",\n \"except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly the\",\n \"description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0,\",\n \"def progress_bar(self): \\\"\\\"\\\"Return a context manager with a print method. (Optional)\\\"\\\"\\\" # Do\",\n \"browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge':\",\n \"Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr =\",\n \"logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt\",\n \"_decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure):\",\n \"files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched') if file\",\n \"len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie\",\n \"'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE,\",\n \"with return code {proc.returncode}. Please consult ' 'the kwallet-query man page for details')\",\n \"- v11: AES-CBC encrypted with an OS protected key (keyring) - v11 keys\",\n \"ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name ==\",\n \"profile is not None and _is_path(profile): profile = os.path.expanduser(profile) return browser_name, profile, keyring\",\n \"i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor,\",\n \"os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could\",\n \"skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def\",\n \"\\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge'\",\n \"classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root,\",\n \"keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if\",\n \"[p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page of\",\n \"else: raise NotImplementedError(f'Chrome cookie decryption is not supported on this platform: {sys.platform}') class\",\n \"b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no\",\n \"None: search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if\",\n \"'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column}\",\n \"\\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. # this may be a bug as\",\n \"1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True)\",\n \"self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self,\",\n \"= p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def\",\n \"get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor\",\n \"raise FileNotFoundError(f'could not find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"')\",\n \"' 'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if\",\n \"_decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length)\",\n \"KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def\",\n \"else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if big_endian\",\n \"'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info =\",\n \"= None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11':\",\n \"message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once)\",\n \"your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password',\",\n \"be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform\",\n \"as con: col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name}\",\n \"is part of the standard library, it is possible to compile python without\",\n \"< 0: raise ParserError(f'invalid read of {num_bytes} bytes') end = self.cursor + num_bytes\",\n \"os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None):\",\n \"SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not\",\n \"return jar finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name,\",\n \"are considered 'old data' which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value\",\n \"self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True) return None\",\n \"unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor is not None:\",\n \"= QuietMultilinePrinter() printer.print = lambda _: None return printer def load_cookies(cookie_file, browser_specification, ydl):\",\n \"enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None,\",\n \"{ 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft\",\n \"cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root, filename, logger): #\",\n \"{'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles }\",\n \"sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True\",\n \"_get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts\",\n \"self._cookie_counts['other'] += 1 # any other prefix means the data is DPAPI encrypted\",\n \"auto() KDE = auto() PANTHEON = auto() UNITY = auto() XFCE = auto()\",\n \"which does a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet\",\n \"cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find\",\n \"finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux',\",\n \"prefixes are considered 'old data' which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return\",\n \"= p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie\",\n \"no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96\",\n \"== _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger):\",\n \"return b'' else: logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return\",\n \"None: self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext,\",\n \"\\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ =\",\n \"failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end of the record') cookie\",\n \"chrome does not check hasEntry and instead # just tries to read the\",\n \"to obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found.\",\n \"or not v10 - v10: AES-GCM encrypted with a key which is encrypted\",\n \"except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the\",\n \"v10: AES-GCM encrypted with a key which is encrypted with DPAPI - not\",\n \"authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to\",\n \"desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in\",\n \"else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE\",\n \"as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, (host, name, value,\",\n \"= None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other':\",\n \"to use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports\",\n \"os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info\",\n \"'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif\",\n \"from hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from\",\n \"p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record\",\n \"keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring ==\",\n \"= p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0:\",\n \"None logger.debug(f'Found local state file at \\\"{path}\\\"') with open(path, encoding='utf8') as f: data\",\n \"# Do not print to files/pipes, loggers, or when --no-progress is used if\",\n \"= encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if\",\n \"raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return\",\n \"module is not installed. ' 'Please install by running `python3 -m pip install\",\n \"while True: c = self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c)\",\n \"printer printer = QuietMultilinePrinter() printer.print = lambda _: None return printer def load_cookies(cookie_file,\",\n \"data' which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def\",\n \"initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8\",\n \"if end > len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor\",\n \"data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in\",\n \"!= 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult ' 'the kwallet-query\",\n \"nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce,\",\n \"- v10: AES-CBC encrypted with an OS protected key (keyring) and more key\",\n \"{sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key\",\n \"keyring, logger): # note: chrome/chromium can be run with the following flags to\",\n \"keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting\",\n \"('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger)\",\n \"in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not None and\",\n \"self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name,\",\n \"secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies\",\n \"https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE\",\n \"self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other prefix means\",\n \"Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'),\",\n \"in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if\",\n \"except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}',\",\n \"_extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting\",\n \"except ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because the MAC check failed. Possibly\",\n \"only_once=True) return record_size p.skip_to(record_size, 'space at the end of the record') cookie =\",\n \"already in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path)\",\n \"body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size),\",\n \"is the same - there are a few bytes here and there which\",\n \"Data'), }[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = {\",\n \"auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\"\",\n \"ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description of pDataIn None,\",\n \"# using `dbus-monitor` during startup, it can be observed that chromium lists all\",\n \"if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True) return\",\n \"in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported\",\n \"record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies\",\n \"record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure =\",\n \"0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root): for\",\n \"item.get_secret() else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger):\",\n \"browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name,\",\n \"keyring backend # it has chosen to use # chromium --enable-logging=stderr --v=1 2>&1\",\n \"cookies are either v10 or not v10 - v10: AES-GCM encrypted with a\",\n \"data appears to be out of date but the important parts of the\",\n \"stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read NetworkWallet')\",\n \"= ( 'as the `secretstorage` module is not installed. ' 'Please install by\",\n \"logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox\",\n \"= profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if\",\n \"not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS):\",\n \"by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes')\",\n \"comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc\",\n \"failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce,\",\n \"password and store # it, but that doesn't matter here. return b'' else:\",\n \"progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space\",\n \"{i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies +=\",\n \"data_format = '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer\",\n \"keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return\",\n \"profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not\",\n \"to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed\",\n \"description of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must be NULL\",\n \"platform: {sys.platform}') # Linux keyring names can be determined by snooping on dbus\",\n \"- v10: AES-CBC encrypted with a fixed key - v11: AES-CBC encrypted with\",\n \"from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie\",\n \"proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except Exception as\",\n \"os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database') with open(cookies_path,\",\n \"with an OS protected key (keyring) - v11 keys can be stored in\",\n \"as KWallet, # using `dbus-monitor` during startup, it can be observed that chromium\",\n \"os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config,\",\n \"jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets\",\n \"not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif\",\n \"module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera',\",\n \"in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn\",\n \"= [] while True: c = self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8')\",\n \"printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer\",\n \"browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if\",\n \"stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read\",\n \"keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING:\",\n \"of the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a\",\n \"stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with\",\n \"installed to read from KWallet. kwallet-query should be' 'included in the kwallet package\",\n \"paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def\",\n \"safari') return jar class ParserError(Exception): pass class DataParser: def __init__(self, data, logger): self._data\",\n \"search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']:\",\n \"ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not\",\n \"== 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop ==\",\n \"in between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size =\",\n \"def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl:\",\n \"lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer\",\n \"record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path,\",\n \"few bytes here and there which are skipped during parsing \\\"\\\"\\\" if jar\",\n \"encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\"\",\n \"browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def\",\n \"_decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari does not\",\n \"None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be installed to\",\n \"= data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State') return None encrypted_key\",\n \"if desktop_session is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return\",\n \"return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 # boringssl\",\n \"message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self,\",\n \"KWallet. kwallet-query should be' 'included in the kwallet package for your distribution') return\",\n \"_open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they are already in use\",\n \"same way as KWallet, # using `dbus-monitor` during startup, it can be observed\",\n \"ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret =\",\n \"of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must be NULL None,\",\n \"plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie (AES-GCM)\",\n \"if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not\",\n \"return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' *\",\n \"GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc\",\n \"\\\"{network_wallet}\\\"') return network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return\",\n \"check failed. Possibly the key is wrong?', only_once=True) return None try: return plaintext.decode('utf-8')\",\n \"if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return\",\n \"{SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not seem to organise keys\",\n \"= lambda _: None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = []\",\n \"nonce) except ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because the MAC check failed.\",\n \"def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager with\",\n \"def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class\",\n \"ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description of pDataIn None, #\",\n \"logger.warning('failed to decrypt cookie (AES-GCM) because the MAC check failed. Possibly the key\",\n \"either v10 or not v10 - v10: AES-GCM encrypted with a key which\",\n \"or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not file.isatty(): return\",\n \"in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value,\",\n \"= YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size\",\n \"False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON\",\n \"this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. # this may be\",\n \"AES-CBC encrypted with a fixed key - v11: AES-CBC encrypted with an OS\",\n \"key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' '\",\n \"import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3\",\n \"return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other prefixes\",\n \"to parse Safari cookie because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space\",\n \"self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot\",\n \"self._logger) else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger):\",\n \"logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is None else\",\n \"{i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length)\",\n \"key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try:\",\n \"dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to decrypt with DPAPI',\",\n \"# will not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring\",\n \"page header field') with _create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading\",\n \"class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger)\",\n \"= auto() PANTHEON = auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum):\",\n \"search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger)\",\n \"cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox':\",\n \"self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True: c = self.read_bytes(1) if c\",\n \"KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by sub classes') @property\",\n \"unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC)\",\n \"None, # pPromptStruct: information about prompts to display 0, # dwFlags ctypes.byref(blob_out) #\",\n \"os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium':\",\n \"\\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp')\",\n \"decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10']\",\n \"record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try:\",\n \"= os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise\",\n \"but that doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:] ==\",\n \"None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key,\",\n \"kwallet-query should be' 'included in the kwallet package for your distribution') return b''\",\n \"behaviour is to generate a random password and store # it, but that\",\n \"YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i,\",\n \"_create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, (host, name,\",\n \"= { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User\",\n \"derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def\",\n \"f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class\",\n \"sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part of the\",\n \"import contextlib import ctypes import json import os import shutil import struct import\",\n \"in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION'\",\n \"value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value =\",\n \"discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are either\",\n \"== b'\\\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running\",\n \"passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html\",\n \"data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State') return None encrypted_key =\",\n \"domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)}\",\n \"with a print method. (Optional)\\\"\\\"\\\" # Do not print to files/pipes, loggers, or\",\n \"not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does\",\n \"return network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet\",\n \"obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet\",\n \"key - v11: AES-CBC encrypted with an OS protected key (keyring) - v11\",\n \"the same - there are a few bytes here and there which are\",\n \"logger) if path is None: logger.error('could not find local state file') return None\",\n \"6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1\",\n \"name = name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value\",\n \"== 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in ('mate',\",\n \"' 'the kwallet-query man page for details') return b'' else: if stdout.lower().startswith(b'failed to\",\n \"# ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy: salt? None, #\",\n \"values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return\",\n \"{secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with\",\n \"not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData,\",\n \"return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None:\",\n \"'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger):\",\n \"Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: #\",\n \"logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult ' 'the kwallet-query man page\",\n \"nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed\",\n \"command not found. KWallet and kwallet-query ' 'must be installed to read from\",\n \"logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor\",\n \"'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name,\",\n \"considered 'old data' which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class\",\n \"__init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10':\",\n \"self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of\",\n \"return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p\",\n \"compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir()\",\n \"ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description)\",\n \"is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if\",\n \"= { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config,\",\n \"call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc\",\n \"p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint()\",\n \"cookies from {browser_name} without sqlite3 support. ' 'Please use a python interpreter compiled\",\n \"does not check hasEntry and instead # just tries to read the value\",\n \"R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local,\",\n \"elif _is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root,\",\n \"jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER =\",\n \"= Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr\",\n \"Overview: Linux: - cookies are either v10 or v11 - v10: AES-CBC encrypted\",\n \"the following flags to determine which keyring backend # it has chosen to\",\n \"= 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count\",\n \"from datetime import datetime, timedelta, timezone from enum import Enum, auto from hashlib\",\n \"to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to the\",\n \"Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger):\",\n \"i, paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files\",\n \"XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING\",\n \"try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet\",\n \"pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version\",\n \"proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult ' 'the\",\n \"_parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes\",\n \"'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform\",\n \"(so no keyring password is required) return None assert False, f'Unknown keyring {keyring}'\",\n \"- [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented\",\n \"except KeyError: logger.error('no encrypted key in Local State') return None encrypted_key = compat_b64decode(base64_key)\",\n \"\\\"\\\"\\\" OTHER = auto() CINNAMON = auto() GNOME = auto() KDE = auto()\",\n \"= _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies') jar\",\n \"self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if\",\n \"print method. (Optional)\\\"\\\"\\\" # Do not print to files/pipes, loggers, or when --no-progress\",\n \"https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir = { 'brave':\",\n \"= 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root):\",\n \"self._v10_key = None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0,\",\n \"description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) +\",\n \"key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata\",\n \"try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding\",\n \"= parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception): pass\",\n \"ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot\",\n \"shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA\",\n \"_decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other prefixes are considered 'old\",\n \"def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32':\",\n \"'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'),\",\n \"SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None)\",\n \"to read password from kwallet. Using empty string instead') # this sometimes occurs\",\n \"= _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue elif not is_encrypted:\",\n \"match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr\",\n \"= ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext,\",\n \"keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from\",\n \"return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ)\",\n \"signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes,\",\n \"None, # ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy: salt? None,\",\n \"end of input') data = self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self,\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet\",\n \"lists all keys # and presumably searches for its key in the list.\",\n \"not find local state file') return None logger.debug(f'Found local state file at \\\"{path}\\\"')\",\n \"= p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding failed',\",\n \"== 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise\",\n \"keyring, logger) self._v11_key = None if password is None else self.derive_key(password) self._cookie_counts =\",\n \"databases if they are already in use (e.g. by the browser) database_copy_path =\",\n \"UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly the key\",\n \"database') with open(cookies_path, 'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger)\",\n \"if printer: return printer printer = QuietMultilinePrinter() printer.print = lambda _: None return\",\n \"+ num_bytes if end > len(self._data): raise ParserError('reached end of input') data =\",\n \"# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def\",\n \"progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file))\",\n \"printer = QuietMultilinePrinter() printer.print = lambda _: None return printer def load_cookies(cookie_file, browser_specification,\",\n \"wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext =\",\n \"if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def\",\n \"hasEntry and instead # just tries to read the value (which kwallet returns\",\n \") from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils\",\n \"p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON\",\n \"pvReserved: must be NULL None, # pPromptStruct: information about prompts to display 0,\",\n \"return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform:\",\n \"details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from\",\n \"decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key,\",\n \"seem to organise keys in the same way as KWallet, # using `dbus-monitor`\",\n \"stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return\",\n \"all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if\",\n \"sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for\",\n \"if jar.filename is not None: output_jar.filename = jar.filename return output_jar def _is_path(value): return\",\n \"'--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr\",\n \"means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile,\",\n \"return None logger.debug(f'Found local state file at \\\"{path}\\\"') with open(path, encoding='utf8') as f:\",\n \"readable description of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must be\",\n \"f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari')\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by sub\",\n \"{browser_name} without sqlite3 support. ' 'Please use a python interpreter compiled with sqlite3\",\n \"flags to determine which keyring backend # it has chosen to use #\",\n \"1') flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field\",\n \"default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception as\",\n \"UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding failed', only_once=True) return record_size\",\n \"key is wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to\",\n \"distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name}\",\n \"else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted']\",\n \"'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else\",\n \"browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring,\",\n \"None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext,\",\n \"cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column =\",\n \"_decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other prefix\",\n \"'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata,\",\n \"in various places depending on the activate desktop environment [2] Mac: - cookies\",\n \"_choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if\",\n \"logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other':\",\n \"jar, logger): p = DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record field\",\n \"cookie because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end\",\n \"nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other prefix means the\",\n \"= _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could not find local\",\n \"profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring\",\n \"path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux:\",\n \"in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to\",\n \"self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp())\",\n \"method. (Optional)\\\"\\\"\\\" # Do not print to files/pipes, loggers, or when --no-progress is\",\n \"if profile is not None: logger.error('safari does not support profiles') if sys.platform !=\",\n \"FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb') as f: cookies_data =\",\n \"YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile\",\n \"found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return\",\n \"cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar()\",\n \"class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in =\",\n \"DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON = auto() GNOME = auto() KDE =\",\n \"self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key =\",\n \"self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager with a print method. (Optional)\\\"\\\"\\\"\",\n \"key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return\",\n \"= self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})')\",\n \"return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key')\",\n \"= _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet used\",\n \"logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password\",\n \"elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else:\",\n \"logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception): pass class DataParser:\",\n \"__init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None\",\n \"pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16):\",\n \"cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path),\",\n \"as the intended behaviour is to generate a random password and store #\",\n \"port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={})\",\n \"\\\"{path}\\\"') with open(path, encoding='utf8') as f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key']\",\n \"v10: AES-CBC encrypted with an OS protected key (keyring) and more key derivation\",\n \"jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p =\",\n \"expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path =\",\n \"else: logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except\",\n \"path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari\",\n \"profiles, take the most recently used one i, paths = 0, [] with\",\n \"= aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because\",\n \"value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False):\",\n \"return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root =\",\n \"expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0,\",\n \"keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', # write password to stdout\",\n \"\\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor =\",\n \"instead') # this sometimes occurs in KDE because chrome does not check hasEntry\",\n \"import ctypes import json import os import shutil import struct import subprocess import\",\n \"keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX keychain')\",\n \"!= 0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet\",\n \"must be NULL None, # pPromptStruct: information about prompts to display 0, #\",\n \"logger) self._v11_key = None if password is None else self.derive_key(password) self._cookie_counts = {'v10':\",\n \"DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home():\",\n \"the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger):\",\n \"if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return\",\n \"'unknown page header field') with _create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets):\",\n \"try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON =\",\n \"v11 keys can be stored in various places depending on the activate desktop\",\n \"logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if cursor is not None:\",\n \"keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file\",\n \"{_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS |\",\n \"keyring names can be determined by snooping on dbus while opening the browser\",\n \"as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path =\",\n \"only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes\",\n \"bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes')\",\n \"stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name,\",\n \"= True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage`\",\n \"+= 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f' ({failed_cookies} could not\",\n \"if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is\",\n \"| {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self,\",\n \"sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes') def\",\n \"if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes') end = self.cursor\",\n \"if proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet =\",\n \"keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform ==\",\n \"= logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is None\",\n \"password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def\",\n \"Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if\",\n \"to determine which keyring backend # it has chosen to use # chromium\",\n \"bug as the intended behaviour is to generate a random password and store\",\n \"support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir']\",\n \"= host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted =\",\n \"linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring =\",\n \"None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar =\",\n \"def __init__(self, ydl=None): self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def\",\n \"_is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in\",\n \"logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except Exception\",\n \"failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies\",\n \"get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger,\",\n \"num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes') end = self.cursor +\",\n \"def skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}')\",\n \"only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM)\",\n \"('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret\",\n \"text is chosen, all cookies are stored as v10 (so no keyring password\",\n \"compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None:\",\n \"moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count =\",\n \"_get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif\",\n \"from safari') return jar class ParserError(Exception): pass class DataParser: def __init__(self, data, logger):\",\n \"is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root =\",\n \"not find safari cookies database') with open(cookies_path, 'rb') as f: cookies_data = f.read()\",\n \"f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode !=\",\n \"== _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic text\",\n \"firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir:\",\n \"def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION',\",\n \"authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because the MAC check\",\n \"_open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies') jar =\",\n \"_LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return\",\n \"('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in\",\n \"with the following flags to determine which keyring backend # it has chosen\",\n \"def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext,\",\n \"jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON = auto()\",\n \"in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce'\",\n \"encoding='utf8') as f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no\",\n \"= False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not be initialized. {_err}'\",\n \"encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8')\",\n \"6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in\",\n \"0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc\",\n \"{'v10': 0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version\",\n \"if browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl),\",\n \"logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown\",\n \"= profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root\",\n \"comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are either v10 or\",\n \"cookies database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor\",\n \"used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try:\",\n \"logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox')\",\n \"None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure\",\n \"None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is\",\n \"| grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection\",\n \"== 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif\",\n \"for \\\"{filename}\\\": {i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return\",\n \"range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)} has no\",\n \"# note: chrome/chromium can be run with the following flags to determine which\",\n \"path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path\",\n \"else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies',\",\n \"not v10: 'old data' stored as plaintext Windows: - cookies are either v10\",\n \"False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from\",\n \"'--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode !=\",\n \"failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall()\",\n \"= {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'}\",\n \"logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly the key is\",\n \"struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d' return\",\n \"self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0:\",\n \"return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key\",\n \"browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0,\",\n \"as progress_bar: for curr_root, dirs, files in os.walk(root): for file in files: i\",\n \"['security', 'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name, # match 'account'\",\n \"_: None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification\",\n \"the Gnome keyring does not seem to organise keys in the same way\",\n \"domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor:\",\n \"stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return\",\n \"cookies are stored as v10 (so no keyring password is required) return None\",\n \"xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop\",\n \"# https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item in col.get_all_items():\",\n \"_LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON\",\n \"decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True)\",\n \"0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext\",\n \"kwallet-query # checks hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while\",\n \"cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies')\",\n \"curr_root, dirs, files in os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching\",\n \"= logger def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of\",\n \"len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end return\",\n \"f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key\",\n \"from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts\",\n \"discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally:\",\n \"message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager with a print\",\n \"auto from hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, )\",\n \"unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from\",\n \"returns \\\"\\\") whereas kwallet-query # checks hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\"\",\n \"as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not\",\n \"file') return None logger.debug(f'Found local state file at \\\"{path}\\\"') with open(path, encoding='utf8') as\",\n \"found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8\",\n \"in os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i:\",\n \"python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage\",\n \"p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to\",\n \"is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8')\",\n \"logger) self._v10_key = None if password is None else self.derive_key(password) self._cookie_counts = {'v10':\",\n \"raise FileNotFoundError(f'could not find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"')\",\n \"= decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0,\",\n \"Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera\",\n \"read from KWallet. kwallet-query should be' 'included in the kwallet package for your\",\n \"None: logger.error('could not find local state file') return None logger.debug(f'Found local state file\",\n \"in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if\",\n \"progress_bar(self): \\\"\\\"\\\"Return a context manager with a print method. (Optional)\\\"\\\"\\\" # Do not\",\n \"os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name]\",\n \"'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger:\",\n \"(keyring) - v11 keys can be stored in various places depending on the\",\n \"CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile,\",\n \"progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, (host, name, value, path,\",\n \"is possible to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE =\",\n \"only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self):\",\n \"if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter()\",\n \"MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger):\",\n \"logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome\",\n \"FileNotFoundError(f'could not find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor\",\n \"noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path\",\n \"'--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode\",\n \"self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] +=\",\n \"path = path.decode('utf-8') is_encrypted = not value and encrypted_value if is_encrypted: value =\",\n \"ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData)\",\n \"cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host,\",\n \"FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count\",\n \"data = self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value, message): value\",\n \"file = self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException: return printer =\",\n \"return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key,\",\n \"be implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented by\",\n \"\\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir)\",\n \"keyring=keyring)) if cookie_file is not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if\",\n \"os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name]\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key\",\n \"p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because\",\n \"_get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is None:\",\n \"search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None:\",\n \"# it, but that doesn't matter here. return b'' else: logger.debug('password found') if\",\n \"'>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = []\",\n \"= b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def\",\n \"return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else:\",\n \"cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return\",\n \"if profile is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile else:\",\n \"except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding failed', only_once=True) return\",\n \"rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if cursor is\",\n \"elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message =\",\n \"_LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies are stored as v10\",\n \"cookie (AES-CBC) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return\",\n \"desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring =\",\n \"_LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return\",\n \"cookies from firefox without sqlite3 support. ' 'Please use a python interpreter compiled\",\n \"'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera'\",\n \"logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"')\",\n \"= _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file =\",\n \"logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return\",\n \"== b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies:\",\n \"the most recently used one i, paths = 0, [] with _create_progress_bar(logger) as\",\n \"None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0}\",\n \"elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root,\",\n \"= _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is None else self.derive_key(password) self._cookie_counts\",\n \"def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0,\",\n \"_get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT:\",\n \"pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size = p.read_uint() p.skip(4,\",\n \"linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet\",\n \"config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root\",\n \"return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS:\",\n \"https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal',\",\n \"if value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value,\",\n \"Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] ==\",\n \"stored in various places depending on the activate desktop environment [2] Mac: -\",\n \"- v10: AES-GCM encrypted with a key which is encrypted with DPAPI -\",\n \"os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif\",\n \"path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could not find\",\n \"config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile\",\n \"table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root, filename,\",\n \"hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat\",\n \"> 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid\",\n \"derivation iterations than linux - not v10: 'old data' stored as plaintext Windows:\",\n \"keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies are stored\",\n \"'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge':\",\n \"# it has chosen to use # chromium --enable-logging=stderr --v=1 2>&1 | grep\",\n \"0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook',\",\n \"elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox')\",\n \"failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] =\",\n \"cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar: for i,\",\n \"== 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome':\",\n \"@staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16)\",\n \"following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send',\",\n \"stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service'\",\n \"os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not\",\n \"= compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return\",\n \"else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger\",\n \"iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext,\",\n \"failed. Possibly the key is wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except\",\n \"between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size = p.read_uint()\",\n \"CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox',\",\n \"os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if\",\n \"num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise\",\n \"== 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local,\",\n \"page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar,\",\n \"con: col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe\",\n \"c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes\",\n \"supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None):\",\n \"DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description\",\n \"not None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session:\",\n \"def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info]\",\n \"return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen,\",\n \"config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium':\",\n \"skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc)\",\n \"{counts}') return jar finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key,\",\n \"self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message):\",\n \"# Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not\",\n \"try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring()\",\n \"logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if\",\n \"== b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11':\",\n \"read the value (which kwallet returns \\\"\\\") whereas kwallet-query # checks hasEntry. To\",\n \"_mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset)\",\n \"YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message)\",\n \"b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password,\",\n \"b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes > 0:\",\n \"cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor =\",\n \"os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32':\",\n \"manager with a print method. (Optional)\\\"\\\"\\\" # Do not print to files/pipes, loggers,\",\n \"\\\"\\\"\\\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5',\",\n \"'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self,\",\n \"- there are a few bytes here and there which are skipped during\",\n \"during startup, it can be observed that chromium lists all keys # and\",\n \"# sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE =\",\n \"of the standard library, it is possible to compile python without # sqlite\",\n \"browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not\",\n \"return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe\",\n \"this data appears to be out of date but the important parts of\",\n \"to read'): logger.debug('failed to read password from kwallet. Using empty string instead') #\",\n \"SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE:\",\n \"sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring:\",\n \"False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS\",\n \"be run with the following flags to determine which keyring backend # it\",\n \"in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment\",\n \"# while starting chrome. # this may be a bug as the intended\",\n \"@property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext =\",\n \"not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support. ' 'Please use\",\n \"\\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto()\",\n \"a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is None:\",\n \"domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\"\",\n \"= YoutubeDLCookieJar() for jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename\",\n \"not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc -\",\n \"p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure = bool(flags & 0x0001)\",\n \"= compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure,\",\n \"appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User\",\n \"os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config,\",\n \"# values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self):\",\n \"safari cookies database') with open(cookies_path, 'rb') as f: cookies_data = f.read() jar =\",\n \"when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file\",\n \"try: proc = Popen( ['security', 'find-generic-password', '-w', # write password to stdout '-a',\",\n \"= YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None,\",\n \"any other prefix means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value,\",\n \"[] while True: c = self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else:\",\n \"'>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format =\",\n \"write password to stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'],\",\n \"import tempfile from datetime import datetime, timedelta, timezone from enum import Enum, auto\",\n \"which is encrypted with DPAPI - not v10: encrypted with DPAPI Sources: -\",\n \"b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b''\",\n \"p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date\",\n \"= ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path,\",\n \"data' stored as plaintext Windows: - cookies are either v10 or not v10\",\n \"it has chosen to use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_\",\n \"SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support. ' 'Please use a\",\n \"v10 - v10: AES-CBC encrypted with an OS protected key (keyring) and more\",\n \"value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return\",\n \"EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length]\",\n \"not file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda\",\n \"cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger)\",\n \"version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False,\",\n \"xdg_current_desktop == 'Unity': if desktop_session is not None and 'gnome-fallback' in desktop_session: return\",\n \"classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return\",\n \"password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext\",\n \"0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult ' 'the kwallet-query man\",\n \"if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path,\",\n \"Do not print to files/pipes, loggers, or when --no-progress is used if not\",\n \"header field') with _create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie\",\n \"logger.warning('failed to decrypt with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData)\",\n \"do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for\",\n \"v10 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else:\",\n \"'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self,\",\n \"raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be determined by snooping\",\n \"== 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): #\",\n \"description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes <\",\n \"+ timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages\",\n \"== 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring,\",\n \"stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet\",\n \"os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform\",\n \"in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def\",\n \"+= 1 # other prefixes are considered 'old data' which were stored as\",\n \"f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read from keyring') return b''\",\n \"v10 or v11 - v10: AES-CBC encrypted with a fixed key - v11:\",\n \"path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for cookie\",\n \"# values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self):\",\n \"backend # it has chosen to use # chromium --enable-logging=stderr --v=1 2>&1 |\",\n \"True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module\",\n \"*SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not None and _is_path(profile): profile\",\n \"be NULL None, # pPromptStruct: information about prompts to display 0, # dwFlags\",\n \"stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet. Using empty string instead')\",\n \"= raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other']\",\n \"way as KWallet, # using `dbus-monitor` during startup, it can be observed that\",\n \"Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}')\",\n \"'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') #\",\n \"FileNotFoundError(f'could not find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with\",\n \"= [] if browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name,\",\n \"def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector))\",\n \"# and presumably searches for its key in the list. It appears that\",\n \"stored as plaintext Windows: - cookies are either v10 or not v10 -\",\n \"iterations than linux - not v10: 'old data' stored as plaintext Windows: -\",\n \"printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer\",\n \"self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d' return struct.unpack(data_format,\",\n \"self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other prefixes are considered 'old data'\",\n \"WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported on this platform:\",\n \"firefox') return jar finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if\",\n \"logger, *, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring,\",\n \"= auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop =\",\n \"domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies\",\n \"cookie (AES-GCM) because the MAC check failed. Possibly the key is wrong?', only_once=True)\",\n \"References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData',\",\n \"jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p =\",\n \"p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset =\",\n \"= json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local\",\n \"keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger)\",\n \"stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception as e: logger.warning(f'exception while obtaining\",\n \"can be observed that chromium lists all keys # and presumably searches for\",\n \"= _firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path\",\n \"is not None: logger.error('safari does not support profiles') if sys.platform != 'darwin': raise\",\n \"YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file)\",\n \"at \\\"{path}\\\"') with open(path, encoding='utf8') as f: data = json.load(f) try: base64_key =\",\n \"as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from\",\n \"open sqlite databases if they are already in use (e.g. by the browser)\",\n \"Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'),\",\n \"json import os import shutil import struct import subprocess import sys import tempfile\",\n \"'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming =\",\n \"is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return is_encrypted,\",\n \"compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry,\",\n \"jar.filename return output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None):\",\n \"compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import\",\n \"is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger,\",\n \"cursor.fetchall() total_cookie_count = len(table) for i, (host, name, value, path, expiry, is_secure) in\",\n \"logger) self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts def\",\n \"to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium\",\n \"_LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if\",\n \"_get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None)\",\n \"cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3\",\n \"secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as\",\n \"path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: -\",\n \"proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet\",\n \"salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext =\",\n \"enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:],\",\n \"does not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if\",\n \"cookies page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header\",\n \"class DataParser: def __init__(self, data, logger): self._data = data self.cursor = 0 self._logger\",\n \"desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif\",\n \"}[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir =\",\n \"_LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of\",\n \"to files/pipes, loggers, or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress')\",\n \"{keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return\",\n \"return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value):\",\n \"not None: logger.error('safari does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported\",\n \"enum import Enum, auto from hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes,\",\n \"if not file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print =\",\n \"({failed_cookies} could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from\",\n \"cookie_file is not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK):\",\n \"key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because the MAC\",\n \"return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON =\",\n \"automatic detection # will not be sufficient in all cases. keyring = _LinuxKeyring[keyring]\",\n \"= cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root, filename, logger):\",\n \"in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger)\",\n \"to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc =\",\n \"- https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD),\",\n \"0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i,\",\n \"description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return\",\n \"location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies\",\n \"extract cookies from firefox without sqlite3 support. ' 'Please use a python interpreter\",\n \"else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True: c\",\n \"field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset)\",\n \"_ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data,\",\n \"an OS protected key (keyring) - v11 keys can be stored in various\",\n \"_parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p\",\n \"unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f' ({failed_cookies} could\",\n \"parse Safari cookie because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at\",\n \"database structure is the same - there are a few bytes here and\",\n \"= _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session\",\n \"encrypted_value): raise NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must\",\n \"in the kwallet package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try:\",\n \"desktop_session is not None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde'\",\n \"logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8')\",\n \"os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could\",\n \"cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return\",\n \"0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version =\",\n \"self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None\",\n \"NotImplementedError(f'Chrome cookie decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def\",\n \"DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB()\",\n \"'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi':\",\n \"firefox without sqlite3 support. ' 'Please use a python interpreter compiled with sqlite3\",\n \"try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)\",\n \"keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not\",\n \"initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except\",\n \"v10 or not v10 - v10: AES-CBC encrypted with an OS protected key\",\n \"be' 'included in the kwallet package for your distribution') return b'' network_wallet =\",\n \"tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature')\",\n \"is None: raise FileNotFoundError(f'could not find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies\",\n \"= config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could\",\n \"'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform ==\",\n \"whereas kwallet-query # checks hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" #\",\n \"if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if\",\n \"ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be determined by snooping on\",\n \"os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir\",\n \"sqlite3 is part of the standard library, it is possible to compile python\",\n \"snooping on dbus while opening the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\"\",\n \"keys in the same way as KWallet, # using `dbus-monitor` during startup, it\",\n \"logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies\",\n \"_parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record\",\n \"only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return\",\n \"p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field 3') expiration_date\",\n \"0: logger.debug(f'a cookies page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown\",\n \"in the list. It appears that we must do the same. # https://github.com/jaraco/keyring/issues/556\",\n \"\\\"\\\"\\\"Return a context manager with a print method. (Optional)\\\"\\\"\\\" # Do not print\",\n \"import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import\",\n \"if they are already in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir,\",\n \"= os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'),\",\n \"def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description)\",\n \"stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None\",\n \"ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location')\",\n \"0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password,\",\n \"failed with return code {proc.returncode}. Please consult ' 'the kwallet-query man page for\",\n \"except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module\",\n \"= sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8')\",\n \"== 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name':\",\n \"from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer\",\n \"kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available\",\n \"'-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE,\",\n \"== 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop ==\",\n \"self._logger) else: self._cookie_counts['other'] += 1 # other prefixes are considered 'old data' which\",\n \"b'' else: logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout\",\n \"[('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out =\",\n \"== 'Unity': if desktop_session is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME\",\n \"from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be\",\n \"0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer:\",\n \"# although sqlite3 is part of the standard library, it is possible to\",\n \"Linux: - cookies are either v10 or v11 - v10: AES-CBC encrypted with\",\n \"parsing \\\"\\\"\\\" if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data,\",\n \"auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto()\",\n \"'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies database\",\n \"the end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False,\",\n \"{keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try:\",\n \"wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call\",\n \"else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes\",\n \"raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'):\",\n \"wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie\",\n \"the value (which kwallet returns \\\"\\\") whereas kwallet-query # checks hasEntry. To verify\",\n \"logger.warning('Cannot extract cookies from firefox without sqlite3 support. ' 'Please use a python\",\n \"aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because the\",\n \"support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except\",\n \"= _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET\",\n \"{e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from kwallet')\",\n \"domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview:\",\n \"p = DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags\",\n \"_create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line in\",\n \"places depending on the activate desktop environment [2] Mac: - cookies are either\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length\",\n \"cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other']\",\n \"_mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger):\",\n \"expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\"\",\n \"GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is\",\n \"iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3]\",\n \"= [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out\",\n \"printer.print = lambda _: None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars =\",\n \"import Enum, auto from hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes,\",\n \"struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True: c = self.read_bytes(1) if\",\n \"p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure = bool(flags &\",\n \"expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain =\",\n \"= stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return\",\n \"is not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True,\",\n \"{ 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name,\",\n \"else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values\",\n \"value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None,\",\n \"the automatic detection # will not be sufficient in all cases. keyring =\",\n \"initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS\",\n \"this sometimes occurs in KDE because chrome does not check hasEntry and instead\",\n \"self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari does not support\",\n \"else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception as e:\",\n \"if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb')\",\n \"item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read from keyring')\",\n \"decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor\",\n \"verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. # this may\",\n \"keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger)\",\n \"stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout = stdout[:-1]\",\n \"logger) p = DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer')\",\n \"True except ImportError: # although sqlite3 is part of the standard library, it\",\n \"not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for\",\n \"logger.warning('failed to parse Safari cookie because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size,\",\n \"blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): #\",\n \"'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'),\",\n \"os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb') as f:\",\n \"encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot\",\n \"os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for cookie in\",\n \"else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles')\",\n \"logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print = lambda _: None\",\n \"NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if\",\n \"find-generic-password to obtain password from OSX keychain') try: proc = Popen( ['security', 'find-generic-password',\",\n \"profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path\",\n \"+= 1 # any other prefix means the data is DPAPI encrypted #\",\n \"take the most recently used one i, paths = 0, [] with _create_progress_bar(logger)\",\n \"jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name\",\n \"6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space\",\n \"cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database')\",\n \"use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is\",\n \"Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata =\",\n \"by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux',\",\n \"if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path):\",\n \"network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder',\",\n \"p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar: for i, record_offset in\",\n \"if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager with a print method.\",\n \"raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not\",\n \"BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0)\",\n \"dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge':\",\n \"aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter,\",\n \"\\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment\",\n \"encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length):\",\n \"host_key = host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted\",\n \"None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config'))\",\n \"tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names\",\n \"ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are either v10 or v11 - v10:\",\n \"xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None:\",\n \"recently used one i, paths = 0, [] with _create_progress_bar(logger) as progress_bar: for\",\n \"logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: #\",\n \"None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not None\",\n \"return jar class ParserError(Exception): pass class DataParser: def __init__(self, data, logger): self._data =\",\n \"return stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def\",\n \"Please consult ' 'the kwallet-query man page for details') return b'' else: if\",\n \"all keys # and presumably searches for its key in the list. It\",\n \"dbus while opening the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name =\",\n \"_extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise\",\n \"def _extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari does not support profiles')\",\n \"from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import\",\n \"elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is\",\n \"YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(),\",\n \"not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True)\",\n \"= os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium':\",\n \"= MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def\",\n \"of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with\",\n \"int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p =\",\n \"= proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except Exception\",\n \"'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if\",\n \"The name of the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which\",\n \"class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are either v10 or v11 -\",\n \"obtain password from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', #\",\n \"with open(path, encoding='utf8') as f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except\",\n \"return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path),\",\n \"keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return\",\n \"be installed to read from KWallet. kwallet-query should be' 'included in the kwallet\",\n \"name of the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does\",\n \"MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie\",\n \"DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is\",\n \"host, name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger)\",\n \"because chrome does not check hasEntry and instead # just tries to read\",\n \"kwallet returns \\\"\\\") whereas kwallet-query # checks hasEntry. To verify this: # dbus-monitor\",\n \"in the same way as KWallet, # using `dbus-monitor` during startup, it can\",\n \"only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None\",\n \"tmpdir): # cannot open sqlite databases if they are already in use (e.g.\",\n \"filename, logger): # if there are multiple browser profiles, take the most recently\",\n \"presumably searches for its key in the list. It appears that we must\",\n \"= logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print = lambda _:\",\n \"'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr =\",\n \"are multiple browser profiles, take the most recently used one i, paths =\",\n \"read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can\",\n \"0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003,\",\n \"- KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by sub classes')\",\n \"_creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name\",\n \"# dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. # this may be a\",\n \"cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path),\",\n \"self._v11_key = None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0,\",\n \"_process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies\",\n \"= p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset\",\n \"value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie =\",\n \"def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password\",\n \"if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read from\",\n \"num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'):\",\n \"1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f' ({failed_cookies} could not be\",\n \"= self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes,\",\n \"p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)]\",\n \"secure_column = 'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value,\",\n \"= DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags =\",\n \"os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi':\",\n \"key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1',\",\n \"return data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value:\",\n \"# cannot open sqlite databases if they are already in use (e.g. by\",\n \"p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse\",\n \"OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', # write password to\",\n \"!= {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I'\",\n \"return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return\",\n \"parts of the database structure is the same - there are a few\",\n \"'<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if big_endian else\",\n \"if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE\",\n \"iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3]\",\n \"dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try:\",\n \"'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported\",\n \"to decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly the key is wrong?',\",\n \"raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I'\",\n \"cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return\",\n \"is not None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in\",\n \"ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer =\",\n \"_firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return\",\n \"elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata,\",\n \"- v11 keys can be stored in various places depending on the activate\",\n \"this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger =\",\n \"of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain),\",\n \"def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property\",\n \"key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will\",\n \"_get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root = profile\",\n \"State', logger) if path is None: logger.error('could not find local state file') return\",\n \"https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData',\",\n \"# any other prefix means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return\",\n \"'old data' which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor):\",\n \"ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True)\",\n \"try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column\",\n \"= p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown\",\n \"not installed. ' 'Please install by running `python3 -m pip install secretstorage`.') except\",\n \"sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return\",\n \"not find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor =\",\n \"self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def\",\n \"_get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is None else self.derive_key(password) self._cookie_counts =\",\n \"return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they\",\n \"(Optional)\\\"\\\"\\\" # Do not print to files/pipes, loggers, or when --no-progress is used\",\n \"'other': 0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3]\",\n \"= encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return\",\n \"def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}')\",\n \"encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] +=\",\n \"matter here. return b'' else: logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout =\",\n \"_get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is None else self.derive_key(password) self._cookie_counts\",\n \"None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity':\",\n \"b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes}\",\n \"None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return\",\n \"SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS =\",\n \"preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if\",\n \"= 'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ],\",\n \"does not seem to organise keys in the same way as KWallet, #\",\n \"local state file') return None logger.debug(f'Found local state file at \\\"{path}\\\"') with open(path,\",\n \"cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3\",\n \"_parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if\",\n \"sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else:\",\n \"_process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name =\",\n \"is None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None #\",\n \"v11 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else:\",\n \"'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in ('mate', 'gnome'):\",\n \"jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f' ({failed_cookies} could not be decrypted)'\",\n \"plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly\",\n \"big_endian=False): data_format = '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self,\",\n \"password from kwallet. Using empty string instead') # this sometimes occurs in KDE\",\n \"# dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to decrypt with\",\n \"if profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir']\",\n \"None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key =\",\n \"Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value):\",\n \"> 0: failed_message = f' ({failed_cookies} could not be decrypted)' else: failed_message =\",\n \"only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other\",\n \"self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context\",\n \"'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata,\",\n \"cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as\",\n \"is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext\",\n \"logger): p = DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1')\",\n \"tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure'\",\n \"buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}):\",\n \"host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8')\",\n \"self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no key\",\n \"None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other prefixes are\",\n \"logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support. ' 'Please use a python\",\n \"_ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)}\",\n \"is None: search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile)\",\n \"by snooping on dbus while opening the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\"\",\n \"= lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'):\",\n \"NULL None, # pPromptStruct: information about prompts to display 0, # dwFlags ctypes.byref(blob_out)\",\n \"class ParserError(Exception): pass class DataParser: def __init__(self, data, logger): self._data = data self.cursor\",\n \"return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif\",\n \"= True except ImportError: # although sqlite3 is part of the standard library,\",\n \"return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return\",\n \"aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter\",\n \"here. return b'' else: logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout = stdout[:-1]\",\n \"'Unity': if desktop_session is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else:\",\n \"'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name,\",\n \"= stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception as e: logger.warning(f'exception while\",\n \"prefix means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def\",\n \"return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env:\",\n \"os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they are already\",\n \"'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise\",\n \"ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), #\",\n \"= self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is\",\n \"[2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by\",\n \"other prefixes are considered 'old data' which were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm\",\n \"is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure):\",\n \"ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else:\",\n \"Local State') return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix):\",\n \"# when basic text is chosen, all cookies are stored as v10 (so\",\n \"def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self):\",\n \"is encrypted with DPAPI - not v10: encrypted with DPAPI Sources: - [1]\",\n \"return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data\",\n \"os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming,\",\n \"enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not\",\n \"sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome',\",\n \"base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State') return None\",\n \"failed_message = f' ({failed_cookies} could not be decrypted)' else: failed_message = '' logger.info(f'Extracted\",\n \"# pOptionalEntropy: salt? None, # pvReserved: must be NULL None, # pPromptStruct: information\",\n \"None, # pvReserved: must be NULL None, # pPromptStruct: information about prompts to\",\n \"in KDE because chrome does not check hasEntry and instead # just tries\",\n \"key in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if\",\n \"kwallet package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc =\",\n \"firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support. '\",\n \"_is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else: if\",\n \"cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if\",\n \"Possibly the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References:\",\n \"LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts')\",\n \"\\\"\\\"\\\" The name of the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet\",\n \"progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False,\",\n \"keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from\",\n \"# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not None:\",\n \"read of {num_bytes} bytes') end = self.cursor + num_bytes if end > len(self._data):\",\n \"opening the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave':\",\n \"\\\"{keyring}\\\"') if profile is not None and _is_path(profile): profile = os.path.expanduser(profile) return browser_name,\",\n \"page for details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read\",\n \"if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None result =\",\n \"_parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file = expand_path(cookie_file)\",\n \"read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def\",\n \"Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not be\",\n \"stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}')\",\n \"= self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException: return printer = MultilinePrinter(file,\",\n \"- self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1,\",\n \"important parts of the database structure is the same - there are a\",\n \"logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def\",\n \"from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return\",\n \"1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data,\",\n \"error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager with a\",\n \"def read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0]\",\n \"{message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if\",\n \"def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer printer\",\n \"Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in\",\n \"_get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def\",\n \"of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self,\",\n \"there are multiple browser profiles, take the most recently used one i, paths\",\n \"= p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value =\",\n \"\\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if\",\n \"if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop\",\n \"\\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date\",\n \"pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode,\",\n \"os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise\",\n \"dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. # this may be a bug\",\n \"is None: raise FileNotFoundError(f'could not find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies\",\n \"= { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata,\",\n \"rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc -\",\n \"== _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else:\",\n \"signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies\",\n \"path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox')\",\n \"= {'v10': 0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value):\",\n \"encrypted with a fixed key - v11: AES-CBC encrypted with an OS protected\",\n \"Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application\",\n \"def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is not None: browser_name,\",\n \"search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise\",\n \"'Please install by running `python3 -m pip install secretstorage`.') except Exception as _err:\",\n \"logger def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes}\",\n \"\\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON = auto() GNOME = auto()\",\n \"if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p\",\n \"_firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path =\",\n \"None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password): #\",\n \"from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try:\",\n \"{message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if\",\n \"_fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer)\",\n \"os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera':\",\n \"self._logger) else: self._cookie_counts['other'] += 1 # any other prefix means the data is\",\n \"env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment =\",\n \"Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)\",\n \"return output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if\",\n \"path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field 3') expiration_date =\",\n \"== 0: logger.debug(f'a cookies page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0],\",\n \"PANTHEON = auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h\",\n \"salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger,\",\n \"kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not\",\n \"to organise keys in the same way as KWallet, # using `dbus-monitor` during\",\n \"bytes here and there which are skipped during parsing \\\"\\\"\\\" if jar is\",\n \"_get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir =\",\n \"available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not seem to organise\",\n \"timedelta, timezone from enum import Enum, auto from hashlib import pbkdf2_hmac from .aes\",\n \"Edge' if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin'\",\n \"use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn =\",\n \"basic text is chosen, all cookies are stored as v10 (so no keyring\",\n \"R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir =\",\n \"chrome. # this may be a bug as the intended behaviour is to\",\n \"is not None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in\",\n \"YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although\",\n \"{num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes}\",\n \"output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name\",\n \"None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is\",\n \"in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not\",\n \"logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32':\",\n \"not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file\",\n \"# other prefixes are considered 'old data' which were stored as plaintext #\",\n \"xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not None and 'gnome-fallback' in\",\n \"num_bytes if end > len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end]\",\n \"_LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is\",\n \"find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger)\",\n \"open(path, encoding='utf8') as f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError:\",\n \"return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root, filename, logger): # if there\",\n \"compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path\",\n \"2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint()\",\n \"= len(table) for i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading\",\n \"= unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor is not\",\n \"0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1,\",\n \"{error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if\",\n \"= os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database') with\",\n \"printer: return printer printer = QuietMultilinePrinter() printer.print = lambda _: None return printer\",\n \"xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop\",\n \"_LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\"\",\n \"searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths else\",\n \"\\\"{filename}\\\": {i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None\",\n \"}[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not\",\n \"key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext\",\n \"from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor\",\n \"DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _\",\n \"logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0} @property def\",\n \"keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not\",\n \"at the end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None,\",\n \"'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger)\",\n \"'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform\",\n \"sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'),\",\n \"browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from\",\n \"(host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}')\",\n \"1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0:\",\n \"version breakdown: {counts}') return jar finally: if cursor is not None: cursor.connection.close() def\",\n \"'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if\",\n \"# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts def\",\n \"in all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}')\",\n \"salt? None, # pvReserved: must be NULL None, # pPromptStruct: information about prompts\",\n \"can be determined by snooping on dbus while opening the browser in KDE:\",\n \"profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies\",\n \"profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root =\",\n \"logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto()\",\n \"not check hasEntry and instead # just tries to read the value (which\",\n \"--v=1 2>&1 | grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the\",\n \"table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser profiles, take\",\n \"'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies\",\n \"same - there are a few bytes here and there which are skipped\",\n \"blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human\",\n \"possible to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False\",\n \"not seem to organise keys in the same way as KWallet, # using\",\n \"_LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE\",\n \"browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot\",\n \"== 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is\",\n \"no keyring password is required) return None assert False, f'Unknown keyring {keyring}' def\",\n \"to stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match\",\n \"_get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key,\",\n \"failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\"\",\n \"number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor\",\n \"Mac: - cookies are either v10 or not v10 - v10: AES-CBC encrypted\",\n \"cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other']\",\n \"a random password and store # it, but that doesn't matter here. return\",\n \"_config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if\",\n \"'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint()\",\n \"p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)]\",\n \"should be' 'included in the kwallet package for your distribution') return b'' network_wallet\",\n \"other prefix means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8')\",\n \"_extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari does not support profiles') if\",\n \"else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon':\",\n \"logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data,\",\n \"'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else:\",\n \"_get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the\",\n \"1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1 if\",\n \"try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding\",\n \"a key which is encrypted with DPAPI - not v10: encrypted with DPAPI\",\n \"file at \\\"{path}\\\"') with open(path, encoding='utf8') as f: data = json.load(f) try: base64_key\",\n \"chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet>\",\n \"support') return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root\",\n \"from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts\",\n \"return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return\",\n \"_LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE\",\n \"field 1') flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record\",\n \"'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform:\",\n \"sqlite3 support. ' 'Please use a python interpreter compiled with sqlite3 support') return\",\n \"= env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop\",\n \"context manager with a print method. (Optional)\\\"\\\"\\\" # Do not print to files/pipes,\",\n \"# pvReserved: must be NULL None, # pPromptStruct: information about prompts to display\",\n \"'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841\",\n \"_merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile,\",\n \"database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring)\",\n \"description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def\",\n \"may be a bug as the intended behaviour is to generate a random\",\n \"if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support. ' 'Please\",\n \"browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge':\",\n \"= logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0} @property\",\n \"data_format = '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False):\",\n \"ValueError: logger.warning('failed to decrypt cookie (AES-GCM) because the MAC check failed. Possibly the\",\n \"is wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt\",\n \"browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome':\",\n \"column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies')\",\n \"expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table =\",\n \"= f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar\",\n \"salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version =\",\n \"is not installed. ' 'Please install by running `python3 -m pip install secretstorage`.')\",\n \"counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally:\",\n \"about prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not\",\n \"_LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment:\",\n \"elif desktop_session is not None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif\",\n \"self.cursor = end return data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if\",\n \"0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password,\",\n \"None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip()\",\n \"not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f'\",\n \"keys # and presumably searches for its key in the list. It appears\",\n \"logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _ in\",\n \"name_offset = p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field\",\n \"number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies ==\",\n \"output_jar = YoutubeDLCookieJar() for jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if\",\n \"= os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if\",\n \"sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'),\",\n \"is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile\",\n \"= False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False\",\n \"error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3\",\n \"# noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset)\",\n \"NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from\",\n \"# https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir = {\",\n \"_LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON = auto() GNOME =\",\n \"table = cursor.fetchall() total_cookie_count = len(table) for i, (host, name, value, path, expiry,\",\n \"return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return\",\n \"value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and encrypted_value if is_encrypted: value\",\n \"which are skipped during parsing \\\"\\\"\\\" if jar is None: jar = YoutubeDLCookieJar()\",\n \"SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS =\",\n \"default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query')\",\n \"if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name}\",\n \"_err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not be\",\n \"State') return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid\",\n \"keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic\",\n \"stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read NetworkWallet') return\",\n \"to read the value (which kwallet returns \\\"\\\") whereas kwallet-query # checks hasEntry.\",\n \"return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop\",\n \"v11: AES-CBC encrypted with an OS protected key (keyring) - v11 keys can\",\n \"are stored as v10 (so no keyring password is required) return None assert\",\n \"total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}')\",\n \"'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return {\",\n \"logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception): pass class DataParser: def\",\n \"return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return\",\n \"SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not installed.\",\n \"item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed\",\n \"of input') data = self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value,\",\n \"is None: self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True) return None return\",\n \"as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes\",\n \"= bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset\",\n \"ParserError(Exception): pass class DataParser: def __init__(self, data, logger): self._data = data self.cursor =\",\n \"None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def\",\n \"port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie)\",\n \"value_offset = p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date =\",\n \"KWalletDBus::NetworkWallet which does a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\"\",\n \"return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version\",\n \"auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\"\",\n \"self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value))\",\n \"= _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar,\",\n \"in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def\",\n \"sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir,\",\n \"not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key\",\n \"logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return\",\n \"offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp):\",\n \"kwallet. Using empty string instead') # this sometimes occurs in KDE because chrome\",\n \"cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform ==\",\n \"if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other':\",\n \"desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def\",\n \"None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar)\",\n \"keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run\",\n \"{browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support. '\",\n \"jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name,\",\n \"_create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}')\",\n \"in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)} has\",\n \"following flags to determine which keyring backend # it has chosen to use\",\n \"if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *,\",\n \"key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1\",\n \"network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query\",\n \"path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies =\",\n \"# write password to stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe\",\n \"config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does\",\n \"cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find\",\n \"printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is not None:\",\n \"return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def\",\n \"_find_most_recently_used_file(root, filename, logger): # if there are multiple browser profiles, take the most\",\n \"with a fixed key - v11: AES-CBC encrypted with an OS protected key\",\n \"value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian\",\n \"be out of date but the important parts of the database structure is\",\n \"self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not file.isatty(): return except\",\n \"+= 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1\",\n \"self._data = data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes): if\",\n \"encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not\",\n \"browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring))\",\n \"for its key in the list. It appears that we must do the\",\n \"contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() ==\",\n \"_decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self,\",\n \"conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return\",\n \"- not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc\",\n \"logger.error('no encrypted key in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix =\",\n \"'as the `secretstorage` module is not installed. ' 'Please install by running `python3\",\n \"value (which kwallet returns \\\"\\\") whereas kwallet-query # checks hasEntry. To verify this:\",\n \"= p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double())\",\n \"`python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON\",\n \"return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page\",\n \"use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports a\",\n \"i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records')\",\n \"not print to files/pipes, loggers, or when --no-progress is used if not self._ydl\",\n \"path is None: logger.error('could not find local state file') return None logger.debug(f'Found local\",\n \"all cookies are stored as v10 (so no keyring password is required) return\",\n \"profile) else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root,\",\n \"= bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names\",\n \"SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the\",\n \"conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in\",\n \"def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True)\",\n \"env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop =\",\n \"be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS =\",\n \"' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError:\",\n \"# this sometimes occurs in KDE because chrome does not check hasEntry and\",\n \"read password from kwallet. Using empty string instead') # this sometimes occurs in\",\n \"self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): #\",\n \"v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService\",\n \"expires=expires_utc, discard=False, comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are\",\n \"'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform ==\",\n \"MAC check failed. Possibly the key is wrong?', only_once=True) return None try: return\",\n \"def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases\",\n \"part of the standard library, it is possible to compile python without #\",\n \"_parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint()\",\n \"== b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes >\",\n \"from {browser_name} without sqlite3 support. ' 'Please use a python interpreter compiled with\",\n \"stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}')\",\n \"determine which keyring backend # it has chosen to use # chromium --enable-logging=stderr\",\n \"plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly\",\n \"= _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING\",\n \"default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet'\",\n \"profile is not None: logger.error('safari does not support profiles') if sys.platform != 'darwin':\",\n \"'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return\",\n \"= path.decode('utf-8') is_encrypted = not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value)\",\n \"To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. # this\",\n \"result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite\",\n \"cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies database in {search_root}') logger.debug(f'Extracting\",\n \"for jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not\",\n \"= CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl\",\n \"Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path\",\n \"decrypt with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result\",\n \"network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to the following function:\",\n \"logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported on this platform: {sys.platform}')\",\n \"def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"')\",\n \"cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting\",\n \"kwallet-query man page for details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed\",\n \"return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return\",\n \"profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support\",\n \"@staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16)\",\n \"most recently used one i, paths = 0, [] with _create_progress_bar(logger) as progress_bar:\",\n \"False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not installed. ' 'Please\",\n \"= _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT\",\n \"def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None:\",\n \"cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length =\",\n \"self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager with a print method. (Optional)\\\"\\\"\\\" #\",\n \"chromium lists all keys # and presumably searches for its key in the\",\n \"class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT\",\n \"def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot\",\n \"= end return data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value\",\n \"return jar finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform\",\n \"the list. It appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with\",\n \"pOptionalEntropy: salt? None, # pvReserved: must be NULL None, # pPromptStruct: information about\",\n \"!= 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying\",\n \"appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'),\",\n \"return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message: printer.print_at_line(f'[Cookies]\",\n \"the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave',\",\n \"decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self): raise\",\n \"if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d'\",\n \"0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip\",\n \"@property def cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name,\",\n \"return conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row\",\n \"else: self._cookie_counts['other'] += 1 # other prefixes are considered 'old data' which were\",\n \"'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed\",\n \"return None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar\",\n \"except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger):\",\n \"= name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and\",\n \"ParserError(f'invalid read of {num_bytes} bytes') end = self.cursor + num_bytes if end >\",\n \"read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet\",\n \"observed that chromium lists all keys # and presumably searches for its key\",\n \"support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is\",\n \"compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date,\",\n \"# just tries to read the value (which kwallet returns \\\"\\\") whereas kwallet-query\",\n \"the key is wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed\",\n \"= len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted,\",\n \"= p.read_uint() path_offset = p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field 3')\",\n \"p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset)\",\n \"password to stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'], #\",\n \"= cursor.fetchall() total_cookie_count = len(table) for i, (host, name, value, path, expiry, is_secure)\",\n \"None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag,\",\n \"= \\\"{network_wallet}\\\"') return network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}')\",\n \"SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported\",\n \"'/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0:\",\n \"if path is None: logger.error('could not find local state file') return None logger.debug(f'Found\",\n \"database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor =\",\n \"with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label()\",\n \"stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}.\",\n \"'<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True: c =\",\n \"field') with _create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i:\",\n \"'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path,\",\n \"table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root, filename, logger): # if\",\n \"for curr_root, dirs, files in os.walk(root): for file in files: i += 1\",\n \"skipped during parsing \\\"\\\"\\\" if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start\",\n \"the kwallet package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc\",\n \"is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'),\",\n \"self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is None\",\n \"not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations,\",\n \"if there are multiple browser profiles, take the most recently used one i,\",\n \"= value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and encrypted_value if is_encrypted:\",\n \"or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException:\",\n \"browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in\",\n \"else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet. Using empty\",\n \"secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret()\",\n \"checks hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome.\",\n \"database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall()\",\n \"xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in\",\n \"port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None, comment_url=None, rest={})\",\n \"secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()):\",\n \"SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support. ' 'Please use a\",\n \"def cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger,\",\n \"DataParser: def __init__(self, data, logger): self._data = data self.cursor = 0 self._logger =\",\n \"8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce =\",\n \"data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise\",\n \"logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without\",\n \"return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key),\",\n \"MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key\",\n \"cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file = expand_path(cookie_file) jar\",\n \"if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else\",\n \"skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif\",\n \"version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False,\",\n \"self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password\",\n \"because the MAC check failed. Possibly the key is wrong?', only_once=True) return None\",\n \"'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support')\",\n \"_decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is\",\n \"environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER:\",\n \"if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root\",\n \"browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile,\",\n \"desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT\",\n \"from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True\",\n \"None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(),\",\n \"with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root): for file in\",\n \"return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def\",\n \"not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}')\",\n \"if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt\",\n \"with open(cookies_path, 'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted\",\n \"search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile)\",\n \"logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies database in\",\n \"6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'),\",\n \"protected key (keyring) and more key derivation iterations than linux - not v10:\",\n \"v11 - v10: AES-CBC encrypted with a fixed key - v11: AES-CBC encrypted\",\n \"\\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring\",\n \"with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def\",\n \"return file = self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException: return printer\",\n \"while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain\",\n \"logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not\",\n \"\\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be implemented by sub classes') @property def\",\n \"f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr =\",\n \"output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return output_jar def _is_path(value):\",\n \"password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is None else self.derive_key(password)\",\n \"no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar: for\",\n \"appears to be out of date but the important parts of the database\",\n \"[p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p\",\n \"return stdout except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def\",\n \"return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with\",\n \"self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no key\",\n \"it is possible to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE\",\n \"= os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome':\",\n \"without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE\",\n \"raise ParserError(f'invalid read of {num_bytes} bytes') end = self.cursor + num_bytes if end\",\n \"DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self,\",\n \"`secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge',\",\n \"of the database structure is the same - there are a few bytes\",\n \"prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger)\",\n \"_get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc\",\n \"= Popen( ['security', 'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name, #\",\n \"compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str,\",\n \"else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux',\",\n \"'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin'\",\n \"{ 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform ==\",\n \"return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported on this\",\n \"], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to\",\n \"supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not be sufficient\",\n \"self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values\",\n \"max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars:\",\n \"jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception):\",\n \"self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not file.isatty():\",\n \"import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses\",\n \"'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera':\",\n \"to decrypt with DPAPI', only_once=True) return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return\",\n \"record_size p.skip_to(record_size, 'space at the end of the record') cookie = compat_cookiejar_Cookie( version=0,\",\n \"elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else:\",\n \"self._cookie_counts['other'] += 1 # other prefixes are considered 'old data' which were stored\",\n \"else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles =\",\n \"failed_cookies > 0: failed_message = f' ({failed_cookies} could not be decrypted)' else: failed_message\",\n \"self._ydl._out_files['error'] try: if not file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False)\",\n \"None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return\",\n \"raise NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be\",\n \"0: failed_message = f' ({failed_cookies} could not be decrypted)' else: failed_message = ''\",\n \"{sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home()\",\n \"= _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name =\",\n \"'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'),\",\n \"# chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports a flag:\",\n \"# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN\",\n \"a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet'\",\n \"the activate desktop environment [2] Mac: - cookies are either v10 or not\",\n \"p.read_uint() record_offsets = [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a\",\n \"elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name,\",\n \"values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def cookie_counts(self): return\",\n \"YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table =\",\n \"in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME\",\n \"logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption\",\n \"by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return\",\n \"ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key,\",\n \"'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'),\",\n \"os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path =\",\n \"from enum import Enum, auto from hashlib import pbkdf2_hmac from .aes import (\",\n \"p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except\",\n \"desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif\",\n \"printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar()\",\n \"{len(jar)} cookies from firefox') return jar finally: if cursor is not None: cursor.connection.close()\",\n \"Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User\",\n \"'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin'\",\n \"kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16\",\n \"{num_bytes} bytes') end = self.cursor + num_bytes if end > len(self._data): raise ParserError('reached\",\n \"{len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as\",\n \"not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger)\",\n \"logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif\",\n \"'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies database\",\n \"def read_cstring(self): buffer = [] while True: c = self.read_bytes(1) if c ==\",\n \"logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of\",\n \"None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc\",\n \"is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox')\",\n \"def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' #\",\n \"date but the important parts of the database structure is the same -\",\n \"p = DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return\",\n \"i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched') if file ==\",\n \"not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop\",\n \"key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key,\",\n \"generate a random password and store # it, but that doesn't matter here.\",\n \"elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies are\",\n \"i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count:\",\n \"run with the following flags to determine which keyring backend # it has\",\n \"and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME':\",\n \"as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not\",\n \"+= 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger\",\n \"return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed.\",\n \"not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None:\",\n \"self._v10_key, self._logger) elif version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None:\",\n \"import os import shutil import struct import subprocess import sys import tempfile from\",\n \"use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name)\",\n \"be observed that chromium lists all keys # and presumably searches for its\",\n \"name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None,\",\n \"rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are either v10 or v11\",\n \"printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print = lambda\",\n \"'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None):\",\n \"= YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table\",\n \"KeyError: logger.error('no encrypted key in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix\",\n \"no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] +=\",\n \"elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif\",\n \"'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported on\",\n \"compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):],\",\n \"{desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring\",\n \"in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise\",\n \"decrypt v10 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger)\",\n \"organise keys in the same way as KWallet, # using `dbus-monitor` during startup,\",\n \"the intended behaviour is to generate a random password and store # it,\",\n \"key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError:\",\n \"(AES-GCM) because the MAC check failed. Possibly the key is wrong?', only_once=True) return\",\n \"0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset\",\n \"encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root,\",\n \"iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b'\",\n \"activate desktop environment [2] Mac: - cookies are either v10 or not v10\",\n \"chrome/chromium can be run with the following flags to determine which keyring backend\",\n \"could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}')\",\n \"secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage`\",\n \"'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config =\",\n \"various places depending on the activate desktop environment [2] Mac: - cookies are\",\n \"structure is the same - there are a few bytes here and there\",\n \"def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser profiles, take the\",\n \"return item.get_secret() else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring,\",\n \"= _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox\",\n \"random password and store # it, but that doesn't matter here. return b''\",\n \"R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera\",\n \"implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in\",\n \"' 'must be installed to read from KWallet. kwallet-query should be' 'included in\",\n \"= ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in),\",\n \"self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version ==\",\n \"is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False,\",\n \"'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'),\",\n \"except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name,\",\n \"logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path,\",\n \"with DPAPI - not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ -\",\n \"*, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform\",\n \"expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar\",\n \"is chosen, all cookies are stored as v10 (so no keyring password is\",\n \"appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'),\",\n \"def read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0]\",\n \"nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext\",\n \"find local state file') return None logger.debug(f'Found local state file at \\\"{path}\\\"') with\",\n \"'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile\",\n \"= data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes\",\n \"def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc\",\n \"KDE because chrome does not check hasEntry and instead # just tries to\",\n \"'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium',\",\n \"raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring:\",\n \"end > len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor =\",\n \"return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open\",\n \"the database structure is the same - there are a few bytes here\",\n \"name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies =\",\n \"jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar:\",\n \"cookies from safari') return jar class ParserError(Exception): pass class DataParser: def __init__(self, data,\",\n \"desktop environment [2] Mac: - cookies are either v10 or not v10 -\",\n \"auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto()\",\n \"3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain\",\n \"parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return jar class ParserError(Exception): pass class\",\n \"version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10\",\n \"function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session',\",\n \"key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 //\",\n \"for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\"\",\n \"== filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda path:\",\n \"def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown\",\n \"DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in\",\n \"logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum):\",\n \"be stored in various places depending on the activate desktop environment [2] Mac:\",\n \"between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def\",\n \"# match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout,\",\n \"read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def\",\n \"logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local\",\n \"0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid\",\n \"NotImplementedError('Must be implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented\",\n \"encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None\",\n \"if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies database in \\\"{search_root}\\\"')\",\n \"logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring ==\",\n \"Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could\",\n \"{sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path =\",\n \"'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera':\",\n \"using `dbus-monitor` during startup, it can be observed that chromium lists all keys\",\n \"return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if\",\n \"are either v10 or v11 - v10: AES-CBC encrypted with a fixed key\",\n \"import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext)\",\n \"_get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when basic text is chosen, all\",\n \"to generate a random password and store # it, but that doesn't matter\",\n \"progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar,\",\n \"None: raise FileNotFoundError(f'could not find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from:\",\n \"sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger)\",\n \"'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill()\",\n \"the MAC check failed. Possibly the key is wrong?', only_once=True) return None try:\",\n \"'-w', # write password to stdout '-a', browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name}\",\n \"authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1\",\n \"# pDataIn None, # ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy:\",\n \"as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset,\",\n \"key in the list. It appears that we must do the same. #\",\n \"and store # it, but that doesn't matter here. return b'' else: logger.debug('password\",\n \"auto() CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON = auto()\",\n \"KWallet and kwallet-query ' 'must be installed to read from KWallet. kwallet-query should\",\n \"elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif\",\n \"It appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as\",\n \"end return data def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value !=\",\n \"from firefox without sqlite3 support. ' 'Please use a python interpreter compiled with\",\n \"sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif\",\n \"16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to\",\n \"0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset -\",\n \"v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length\",\n \"_get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys',\",\n \"intended behaviour is to generate a random password and store # it, but\",\n \"_LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return\",\n \"_extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in CHROMIUM_BASED_BROWSERS:\",\n \"only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 #\",\n \"running `python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False\",\n \"= encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None:\",\n \"= cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i:\",\n \"None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform\",\n \"starting chrome. # this may be a bug as the intended behaviour is\",\n \"'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar =\",\n \"= 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0: raise\",\n \"self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key = None if password is\",\n \"{error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}')\",\n \"sys import tempfile from datetime import datetime, timedelta, timezone from enum import Enum,\",\n \"= None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry,\",\n \"obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password\",\n \"if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config,\",\n \"'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles\",\n \"= not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is\",\n \"return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path\",\n \"return b'' # the Gnome keyring does not seem to organise keys in\",\n \"buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData(\",\n \"does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path\",\n \") if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None result\",\n \"_LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet used to\",\n \"domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return\",\n \"MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE\",\n \"cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return\",\n \"None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is\",\n \"else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is\",\n \"= jar.filename return output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None,\",\n \"GNOME = auto() KDE = auto() PANTHEON = auto() UNITY = auto() XFCE\",\n \"{proc.returncode}. Please consult ' 'the kwallet-query man page for details') return b'' else:\",\n \"b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage',\",\n \"were stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root,\",\n \"xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop\",\n \"> len(self._data): raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end\",\n \"cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir:\",\n \"page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h\",\n \"this may be a bug as the intended behaviour is to generate a\",\n \"b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no\",\n \"config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root =\",\n \"v10 (so no keyring password is required) return None assert False, f'Unknown keyring\",\n \"col = secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage':\",\n \"if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in\",\n \"_LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session =\",\n \"os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin':\",\n \"return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return\",\n \"Windows: - cookies are either v10 or not v10 - v10: AES-GCM encrypted\",\n \"# https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger\",\n \"record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears\",\n \"p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding failed', only_once=True)\",\n \"from kwallet. Using empty string instead') # this sometimes occurs in KDE because\",\n \"cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}')\",\n \"than linux - not v10: 'old data' stored as plaintext Windows: - cookies\",\n \"- [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise\",\n \"p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring()\",\n \"because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None def\",\n \"== _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif\",\n \"def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for cookie in jar:\",\n \"= auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env):\",\n \"try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State') return\",\n \"determined by snooping on dbus while opening the browser in KDE: # dbus-monitor\",\n \"is None: logger.error('could not find local state file') return None logger.debug(f'Found local state\",\n \"else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the\",\n \"'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User\",\n \"`secretstorage` module is not installed. ' 'Please install by running `python3 -m pip\",\n \"= 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for\",\n \".aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from\",\n \"encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key\",\n \"( 'as the `secretstorage` module is not installed. ' 'Please install by running\",\n \"{num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'):\",\n \"which keyring backend # it has chosen to use # chromium --enable-logging=stderr --v=1\",\n \"try: if not file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print\",\n \"json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted key in Local State')\",\n \"for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query',\",\n \"(which kwallet returns \\\"\\\") whereas kwallet-query # checks hasEntry. To verify this: #\",\n \"_is_path(profile): search_root = profile else: search_root = os.path.join(_firefox_browser_dir(), profile) cookie_database_path = _find_most_recently_used_file(search_root, 'cookies.sqlite',\",\n \"= _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring()\",\n \"jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for\",\n \"logger.debug(f'a cookies page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page\",\n \"0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database\",\n \"return None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because\",\n \"not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not None\",\n \"'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'),\",\n \"as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using\",\n \"return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform\",\n \"tempfile from datetime import datetime, timedelta, timezone from enum import Enum, auto from\",\n \"_LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT =\",\n \"message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value} !=\",\n \"else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): #\",\n \"not v10 - v10: AES-GCM encrypted with a key which is encrypted with\",\n \"}[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be determined\",\n \"None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength nonce_length = 96 // 8 # boringssl #\",\n \"the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item\",\n \"its key in the list. It appears that we must do the same.\",\n \"return record_size p.skip_to(record_size, 'space at the end of the record') cookie = compat_cookiejar_Cookie(\",\n \"browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring)\",\n \"expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value:\",\n \"encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI' if not encrypted_key.startswith(prefix): logger.error('invalid key') return None\",\n \"os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d}\",\n \"value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser:\",\n \"or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return\",\n \"an OS protected key (keyring) and more key derivation iterations than linux -\",\n \"read'): logger.debug('failed to read password from kwallet. Using empty string instead') # this\",\n \"or v11 - v10: AES-CBC encrypted with a fixed key - v11: AES-CBC\",\n \"for file in files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files\",\n \"version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False,\",\n \"return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True: c = self.read_bytes(1)\",\n \"= DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar\",\n \"flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not be sufficient in all\",\n \"encrypted with an OS protected key (keyring) and more key derivation iterations than\",\n \"# pPromptStruct: information about prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut\",\n \"return code {proc.returncode}. Please consult ' 'the kwallet-query man page for details') return\",\n \"'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon':\",\n \"c = self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self,\",\n \"config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor =\",\n \"self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self): return self._cookie_counts def decrypt(self,\",\n \"Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5',\",\n \"*line) if not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies +=\",\n \"b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet. Using\",\n \"cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8')\",\n \"{i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if\",\n \"if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies database in {search_root}')\",\n \"isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall()\",\n \"return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop\",\n \"not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path =\",\n \"len(table) for i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie\",\n \"= {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from\",\n \"depending on the activate desktop environment [2] Mac: - cookies are either v10\",\n \"import struct import subprocess import sys import tempfile from datetime import datetime, timedelta,\",\n \"logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without\",\n \"plaintext Windows: - cookies are either v10 or not v10 - v10: AES-GCM\",\n \"Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if\",\n \"elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif\",\n \"= self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value, message): value =\",\n \"= proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please\",\n \"e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE:\",\n \"warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message)\",\n \"jar finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value,\",\n \"big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if\",\n \"= _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure'\",\n \"running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not\",\n \"raise ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end return data\",\n \"is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:],\",\n \"will not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else\",\n \"{value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else\",\n \"is required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using\",\n \"import datetime, timedelta, timezone from enum import Enum, auto from hashlib import pbkdf2_hmac\",\n \"if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc,\",\n \"message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer =\",\n \"sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave':\",\n \"out of date but the important parts of the database structure is the\",\n \"Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform\",\n \"{'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message):\",\n \"\\\"\\\") whereas kwallet-query # checks hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\"\",\n \"self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key,\",\n \"domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value\",\n \"Possibly the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag,\",\n \"( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7, ) from .compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import\",\n \"finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value,\",\n \"= 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag =\",\n \"be sufficient in all cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen\",\n \"stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception\",\n \"else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password):\",\n \"keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key\",\n \"find {browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'],\",\n \"if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar()\",\n \"only_once=True) return None def _decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext,\",\n \"browser_keyring_name, # match 'account' '-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)\",\n \"multiple browser profiles, take the most recently used one i, paths = 0,\",\n \"are skipped during parsing \\\"\\\"\\\" if jar is None: jar = YoutubeDLCookieJar() page_sizes,\",\n \"the standard library, it is possible to compile python without # sqlite support.\",\n \"if xdg_current_desktop == 'Unity': if desktop_session is not None and 'gnome-fallback' in desktop_session:\",\n \"value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None,\",\n \"required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password\",\n \"in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name,\",\n \"class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger)\",\n \"state file') return None logger.debug(f'Found local state file at \\\"{path}\\\"') with open(path, encoding='utf8')\",\n \"os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application\",\n \"dirs, files in os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for\",\n \"References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date but\",\n \"appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con:\",\n \"either v10 or v11 - v10: AES-CBC encrypted with a fixed key -\",\n \"def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with the following\",\n \"logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to\",\n \"return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class\",\n \"= ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description of pDataIn\",\n \"AES-CBC encrypted with an OS protected key (keyring) and more key derivation iterations\",\n \"support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies')\",\n \"- cookies are either v10 or not v10 - v10: AES-GCM encrypted with\",\n \"'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi'\",\n \"name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None,\",\n \"'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop == 'X-Cinnamon': return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE':\",\n \"None: raise FileNotFoundError(f'could not find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from:\",\n \"network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet: {e}') return default_wallet def\",\n \"when basic text is chosen, all cookies are stored as v10 (so no\",\n \"path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None,\",\n \"end = self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end of\",\n \"as f: data = json.load(f) try: base64_key = data['os_crypt']['encrypted_key'] except KeyError: logger.error('no encrypted\",\n \"ImportError: # although sqlite3 is part of the standard library, it is possible\",\n \"and kwallet-query ' 'must be installed to read from KWallet. kwallet-query should be'\",\n \"= auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment\",\n \"version == b'v11': self._cookie_counts['v11'] += 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11\",\n \"logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name}\",\n \"- not v10: 'old data' stored as plaintext Windows: - cookies are either\",\n \"self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'):\",\n \"and more key derivation iterations than linux - not v10: 'old data' stored\",\n \"check hasEntry and instead # just tries to read the value (which kwallet\",\n \"man page for details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to\",\n \"for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page of size\",\n \"profile is None: search_root = _firefox_browser_dir() elif _is_path(profile): search_root = profile else: search_root\",\n \"in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform\",\n \"'included in the kwallet package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger)\",\n \"can be stored in various places depending on the activate desktop environment [2]\",\n \"logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_\",\n \"for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie =\",\n \"raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None):\",\n \"range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00',\",\n \"if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must\",\n \"in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename\",\n \"DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, #\",\n \"in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID'\",\n \"p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) #\",\n \"UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_aes_gcm(ciphertext,\",\n \"cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies from safari') return\",\n \"total_cookie_count = len(table) for i, (host, name, value, path, expiry, is_secure) in enumerate(table):\",\n \"# the Gnome keyring does not seem to organise keys in the same\",\n \"key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because\",\n \"python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root\",\n \"while starting chrome. # this may be a bug as the intended behaviour\",\n \"proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip()\",\n \"_LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return\",\n \"return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import\",\n \"Possibly the key is wrong?', only_once=True) return None try: return plaintext.decode('utf-8') except UnicodeDecodeError:\",\n \"size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger)\",\n \"elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif\",\n \"as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table):\",\n \"cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count:\",\n \"ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key,\",\n \"found. KWallet and kwallet-query ' 'must be installed to read from KWallet. kwallet-query\",\n \"encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif\",\n \"b'\\\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query:\",\n \"6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path,\",\n \"os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else:\",\n \"See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError:\",\n \"read_cstring(self): buffer = [] while True: c = self.read_bytes(1) if c == b'\\\\x00':\",\n \"https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date but the important\",\n \"is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name,\",\n \"return _LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return\",\n \"logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception as e: logger.warning(f'exception while obtaining NetworkWallet:\",\n \"== 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop ==\",\n \"interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is\",\n \"import json import os import shutil import struct import subprocess import sys import\",\n \"[] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root): for file\",\n \"('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform ==\",\n \"that chromium lists all keys # and presumably searches for its key in\",\n \"installed. ' 'Please install by running `python3 -m pip install secretstorage`.') except Exception\",\n \"'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'}\",\n \"python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile\",\n \"be a bug as the intended behaviour is to generate a random password\",\n \"# if there are multiple browser profiles, take the most recently used one\",\n \"key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for\",\n \"browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local,\",\n \"if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name,\",\n \"logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger)\",\n \"logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key is\",\n \"wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from\",\n \"are either v10 or not v10 - v10: AES-GCM encrypted with a key\",\n \"and presumably searches for its key in the list. It appears that we\",\n \"{'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class\",\n \"'space between records') record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages')\",\n \"' 'Please install by running `python3 -m pip install secretstorage`.') except Exception as\",\n \"interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root =\",\n \"'--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode\",\n \"def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they are already in\",\n \"not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support. ' 'Please use\",\n \"'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif\",\n \"logger): logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query\",\n \"'Microsoft Edge' if sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform ==\",\n \"_open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if\",\n \"{expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON = auto() GNOME = auto() KDE\",\n \"datetime, timedelta, timezone from enum import Enum, auto from hashlib import pbkdf2_hmac from\",\n \"_create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer printer =\",\n \"while opening the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = {\",\n \"_LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc\",\n \"bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else\",\n \"if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile,\",\n \"f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if\",\n \"'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir\",\n \"'gnome'): return _LinuxDesktopEnvironment.GNOME elif 'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session:\",\n \"auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP',\",\n \"== 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi':\",\n \"jar class ParserError(Exception): pass class DataParser: def __init__(self, data, logger): self._data = data\",\n \"of date but the important parts of the database structure is the same\",\n \"num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes') end =\",\n \"return printer printer = QuietMultilinePrinter() printer.print = lambda _: None return printer def\",\n \"{i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host),\",\n \"def __init__(self, data, logger): self._data = data self.cursor = 0 self._logger = logger\",\n \"= os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile)\",\n \"1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password\",\n \"not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie)\",\n \"bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset =\",\n \"is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\"\",\n \"= _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name}\",\n \"if profile is not None and _is_path(profile): profile = os.path.expanduser(profile) return browser_name, profile,\",\n \"}[browser_name] elif sys.platform == 'darwin': appdata = os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave':\",\n \"table = cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading cookie\",\n \"== 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not supported\",\n \"jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return output_jar def\",\n \"grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic detection #\",\n \"used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to\",\n \"[] if browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile,\",\n \"string instead') # this sometimes occurs in KDE because chrome does not check\",\n \"= _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root =\",\n \"encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext,\",\n \"= secretstorage.get_default_collection(con) for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return\",\n \"sys.platform == 'darwin' else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium',\",\n \"= Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE,\",\n \"'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera':\",\n \"b'' # the Gnome keyring does not seem to organise keys in the\",\n \"CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def\",\n \"not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts\",\n \"occurs in KDE because chrome does not check hasEntry and instead # just\",\n \"ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved:\",\n \"is None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be installed\",\n \"is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint()\",\n \"'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)} cookies\",\n \"2>&1 | grep key_storage_ # Chromium supports a flag: --password-store=<basic|gnome|kwallet> so the automatic\",\n \"'Local State', logger) if path is None: logger.error('could not find local state file')\",\n \"buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr:\",\n \"pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must be NULL None, #\",\n \"table_name): table_info = cursor.execute(f'PRAGMA table_info({table_name})').fetchall() return [row[1].decode('utf-8') for row in table_info] def _find_most_recently_used_file(root,\",\n \"continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message\",\n \"authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other prefix means the data\",\n \"with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root\",\n \"UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext,\",\n \"pDataIn None, # ppszDataDescr: human readable description of pDataIn None, # pOptionalEntropy: salt?\",\n \"+= 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies >\",\n \"if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name,\",\n \"os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi':\",\n \"or not v10 - v10: AES-CBC encrypted with an OS protected key (keyring)\",\n \"has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar:\",\n \"(e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path)\",\n \"_extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from\",\n \"= auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET =\",\n \"DPAPI - not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2]\",\n \"def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data,\",\n \"logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure\",\n \"to decrypt cookie (AES-GCM) because the MAC check failed. Possibly the key is\",\n \"(AES-GCM) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True) return None\",\n \"'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name\",\n \"= '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer =\",\n \"platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path\",\n \"cookie_counts(self): raise NotImplementedError('Must be implemented by sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *,\",\n \"is_encrypted = not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value\",\n \"more key derivation iterations than linux - not v10: 'old data' stored as\",\n \"'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be\",\n \"[1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must\",\n \"domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted\",\n \"return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if profile is not None: logger.error('safari does\",\n \"= p.read_uint() value_offset = p.read_uint() p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double())\",\n \"xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not None and\",\n \"elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session\",\n \"with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory\",\n \"env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger):\",\n \"has chosen to use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ #\",\n \"auto() PANTHEON = auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\"\",\n \"except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger):\",\n \"None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path,\",\n \"return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-CBC) because UTF-8 decoding failed.\",\n \"return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring ==\",\n \"_get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc =\",\n \"None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: - https://docs.microsoft.com/en-us/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata \\\"\\\"\\\" from ctypes.wintypes import DWORD\",\n \"DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))] buffer = ctypes.create_string_buffer(ciphertext) blob_in = DATA_BLOB(ctypes.sizeof(buffer),\",\n \"def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl:\",\n \"result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def\",\n \"column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in column_names else 'secure'\",\n \"keys can be stored in various places depending on the activate desktop environment\",\n \"file.isatty(): return except BaseException: return printer = MultilinePrinter(file, preserve_output=False) printer.print = lambda message:\",\n \"a print method. (Optional)\\\"\\\"\\\" # Do not print to files/pipes, loggers, or when\",\n \"= auto() UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend\",\n \"os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported\",\n \"import subprocess import sys import tempfile from datetime import datetime, timedelta, timezone from\",\n \"path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data,\",\n \"file)) return None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars):\",\n \"= f'as the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave',\",\n \"elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME\",\n \"desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in\",\n \"not found. KWallet and kwallet-query ' 'must be installed to read from KWallet.\",\n \"return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to\",\n \"None try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8\",\n \"proc = Popen([ 'dbus-send', '--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout,\",\n \"timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages =\",\n \"raise NotImplementedError(f'Chrome cookie decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor):\",\n \"\\\"\\\"\\\" if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger)\",\n \"if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return { 'browser_dir':\",\n \"stored as v10 (so no keyring password is required) return None assert False,\",\n \"on dbus while opening the browser in KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name\",\n \"= 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext =\",\n \"in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser profiles,\",\n \"p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger) record_size\",\n \"tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host,\",\n \"code {proc.returncode}. Please consult ' 'the kwallet-query man page for details') return b''\",\n \"found') if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except Exception as\",\n \"AES-CBC encrypted with an OS protected key (keyring) - v11 keys can be\",\n \"else 'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if\",\n \"True: c = self.read_bytes(1) if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def\",\n \"= YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for\",\n \"from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract cookies from {browser_name} without sqlite3 support.\",\n \"the wallet used to store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus\",\n \"- cookies are either v10 or v11 - v10: AES-CBC encrypted with a\",\n \"[2] Mac: - cookies are either v10 or not v10 - v10: AES-CBC\",\n \"def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name, profile=None, keyring=None): if browser_name not\",\n \"platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger\",\n \"# match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n':\",\n \"'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md\",\n \"jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table)\",\n \"logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version\",\n \"open(cookies_path, 'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data, logger=logger) logger.info(f'Extracted {len(jar)}\",\n \"browser: \\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if\",\n \"# kNonceLength nonce_length = 96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length =\",\n \"page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in page_sizes:\",\n \"debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def\",\n \"'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>',\",\n \"None, # pOptionalEntropy: salt? None, # pvReserved: must be NULL None, # pPromptStruct:\",\n \"except ImportError: # although sqlite3 is part of the standard library, it is\",\n \"derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1003, key_length=16) @property def\",\n \"encrypted with a key which is encrypted with DPAPI - not v10: encrypted\",\n \"{ 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'),\",\n \"the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium',\",\n \"# boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length]\",\n \"_get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could\",\n \"not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb') as\",\n \"port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie)\",\n \"self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc #\",\n \"else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if\",\n \"unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table)\",\n \"auto() GNOME = auto() KDE = auto() PANTHEON = auto() UNITY = auto()\",\n \"def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies\",\n \"\\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile\",\n \"ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable description of\",\n \"'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return\",\n \"although sqlite3 is part of the standard library, it is possible to compile\",\n \"logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in\",\n \"sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome cookie decryption is not\",\n \"try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM\",\n \"there which are skipped during parsing \\\"\\\"\\\" if jar is None: jar =\",\n \"encrypted key in Local State') return None encrypted_key = compat_b64decode(base64_key) prefix = b'DPAPI'\",\n \"return printer def _create_progress_bar(logger): if hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return\",\n \"_LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring\",\n \"NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except\",\n \"cookies are either v10 or v11 - v10: AES-CBC encrypted with a fixed\",\n \"logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment\",\n \"must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con)\",\n \"f' ({failed_cookies} could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies\",\n \"SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl =\",\n \"shutil import struct import subprocess import sys import tempfile from datetime import datetime,\",\n \"elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset,\",\n \"cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies')\",\n \"decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name,\",\n \"return _LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in ('mate', 'gnome'): return\",\n \"'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS = CHROMIUM_BASED_BROWSERS | {'firefox', 'safari'} class YDLLogger: def\",\n \"1 # other prefixes are considered 'old data' which were stored as plaintext\",\n \"not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'} SUPPORTED_BROWSERS\",\n \"message, only_once=False): if self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def\",\n \"SQLITE_AVAILABLE = False try: import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE =\",\n \"if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else\",\n \"password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0}\",\n \"= os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor, table_name):\",\n \"contextlib import ctypes import json import os import shutil import struct import subprocess\",\n \"None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in value def\",\n \"= _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger):\",\n \"!= expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format\",\n \"def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10':\",\n \"browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger)\",\n \"skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def\",\n \"desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if\",\n \"DataParser(data[body_start:], logger) for page_size in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class\",\n \"{browser_name} cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'],\",\n \"encrypted with DPAPI - not v10: encrypted with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/\",\n \"= p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint() is_secure = bool(flags\",\n \"and there which are skipped during parsing \\\"\\\"\\\" if jar is None: jar\",\n \"searches for its key in the list. It appears that we must do\",\n \"they are already in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite')\",\n \"OTHER = auto() CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON\",\n \"in files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched') if\",\n \"logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies database in\",\n \"def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version = encrypted_value[:3] ciphertext = encrypted_value[3:]\",\n \"struct import subprocess import sys import tempfile from datetime import datetime, timedelta, timezone\",\n \"find firefox cookies database in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as\",\n \"'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'),\",\n \"proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ],\",\n \"page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature')\",\n \"value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie(\",\n \"hasattr(logger, 'progress_bar'): printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print\",\n \"'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\"\",\n \"not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *,\",\n \"UnicodeDecodeError: logger.warning('failed to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key\",\n \"jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename =\",\n \"on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger\",\n \"os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}')\",\n \"- this data appears to be out of date but the important parts\",\n \"boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext\",\n \"1, 0, 0, tzinfo=timezone.utc) + timedelta(seconds=timestamp)).timestamp()) def _parse_safari_cookies_header(data, logger): p = DataParser(data, logger)\",\n \"implemented by sub classes') @property def cookie_counts(self): raise NotImplementedError('Must be implemented by sub\",\n \"_mac_absolute_time_to_posix(p.read_double()) # noqa: F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring()\",\n \"does a dbus call to the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet =\",\n \"progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line in enumerate(table): progress_bar.print(f'Loading\",\n \"_LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring\",\n \"here and there which are skipped during parsing \\\"\\\"\\\" if jar is None:\",\n \"if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0:\",\n \"auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\"\",\n \"fixed key - v11: AES-CBC encrypted with an OS protected key (keyring) -\",\n \"sometimes occurs in KDE because chrome does not check hasEntry and instead #\",\n \"1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched') if file == filename: paths.append(os.path.join(curr_root,\",\n \"= _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config,\",\n \"== f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read from keyring') return\",\n \"None: jar = YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger)\",\n \"config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'],\",\n \"os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux\",\n \"_decrypt_aes_cbc(ciphertext, key, logger, initialization_vector=b' ' * 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try:\",\n \"self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end of input') data\",\n \"decoding failed. Possibly the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger):\",\n \"None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt,\",\n \"= DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for\",\n \"def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name\",\n \"hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting chrome. #\",\n \"of {num_bytes} bytes') end = self.cursor + num_bytes if end > len(self._data): raise\",\n \"_choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif keyring\",\n \"'unknown record field 1') flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4,\",\n \"be determined by snooping on dbus while opening the browser in KDE: #\",\n \"because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end of\",\n \"plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger =\",\n \"progress_bar: for curr_root, dirs, files in os.walk(root): for file in files: i +=\",\n \"name, value, encrypted_value, path, expires_utc, is_secure): host_key = host_key.decode('utf-8') name = name.decode('utf-8') value\",\n \"`dbus-monitor` during startup, it can be observed that chromium lists all keys #\",\n \"return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else: raise NotImplementedError(f'Chrome\",\n \"= '>I' if big_endian else '<I' return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format\",\n \"{len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown:\",\n \"try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except ValueError: logger.warning('failed to decrypt cookie\",\n \"if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult '\",\n \"for row in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple\",\n \"to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544 SQLITE_AVAILABLE = False try:\",\n \"search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles']\",\n \"load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is not None: browser_name, profile,\",\n \"not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not\",\n \"pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as\",\n \"key (keyring) - v11 keys can be stored in various places depending on\",\n \"\\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys()\",\n \"not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not seem to\",\n \"comment=None, comment_url=None, rest={}) class ChromeCookieDecryptor: \\\"\\\"\\\" Overview: Linux: - cookies are either v10\",\n \"if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if\",\n \"Enum, auto from hashlib import pbkdf2_hmac from .aes import ( aes_cbc_decrypt_bytes, aes_gcm_decrypt_and_verify_bytes, unpad_pkcs7,\",\n \"return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value):\",\n \"with DPAPI Sources: - [1] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def\",\n \"b'\\\\n': stdout = stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running find-generic-password:\",\n \"password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and\",\n \"from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support.\",\n \"import sys import tempfile from datetime import datetime, timedelta, timezone from enum import\",\n \"be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts =\",\n \"not None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in value\",\n \"= _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0} @property def cookie_counts(self): return\",\n \"ctypes import json import os import shutil import struct import subprocess import sys\",\n \"SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part of the standard\",\n \"value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None,\",\n \"not v10 - v10: AES-CBC encrypted with an OS protected key (keyring) and\",\n \"CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON = auto() UNITY\",\n \"value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None,\",\n \"is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue elif\",\n \"in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length =\",\n \"'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring\",\n \"self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001,\",\n \"path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar: table\",\n \"comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if\",\n \"= [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger):\",\n \"logger): path = _find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could not\",\n \"decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return is_encrypted, compat_cookiejar_Cookie( version=0, name=name,\",\n \"breakdown: {counts}') return jar finally: if cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor,\",\n \"comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if cursor\",\n \".minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import\",\n \"authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag\",\n \"= raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 #\",\n \"in ('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome':\",\n \"'--session', '--print-reply=literal', '--dest=org.kde.kwalletd5', '/modules/kwalletd5', 'org.kde.KWallet.networkWallet' ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if\",\n \"logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring does not seem\",\n \"on the activate desktop environment [2] Mac: - cookies are either v10 or\",\n \"to decrypt cookie (AES-GCM) because UTF-8 decoding failed. Possibly the key is wrong?',\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING = auto() BASICTEXT = auto() SUPPORTED_KEYRINGS\",\n \"= {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm\",\n \"stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b''\",\n \"are a few bytes here and there which are skipped during parsing \\\"\\\"\\\"\",\n \"0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to decrypt\",\n \"'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session is not\",\n \"chosen, all cookies are stored as v10 (so no keyring password is required)\",\n \"if not encrypted_key.startswith(prefix): logger.error('invalid key') return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt,\",\n \"decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy()\",\n \"decrypt v10 cookies: no key found', only_once=True) return None # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc # kNonceLength\",\n \"a few bytes here and there which are skipped during parsing \\\"\\\"\\\" if\",\n \"self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data), description) def _mac_absolute_time_to_posix(timestamp): return int((datetime(2001, 1, 1,\",\n \"p.skip(8, 'unknown record field 3') expiration_date = _mac_absolute_time_to_posix(p.read_double()) _creation_date = _mac_absolute_time_to_posix(p.read_double()) # noqa:\",\n \"value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8 decoding\",\n \"from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query\",\n \"value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and encrypted_value if\",\n \"elif sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def\",\n \"None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor):\",\n \"# this may be a bug as the intended behaviour is to generate\",\n \"'-s', f'{browser_keyring_name} Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill()\",\n \"display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret: logger.warning('failed to\",\n \"if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage not available {SECRETSTORAGE_UNAVAILABLE_REASON}') return b'' # the Gnome keyring\",\n \"return struct.unpack(data_format, self.read_bytes(4))[0] def read_double(self, big_endian=False): data_format = '>d' if big_endian else '<d'\",\n \"keyring: \\\"{keyring}\\\"') if profile is not None and _is_path(profile): profile = os.path.expanduser(profile) return\",\n \"in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename return output_jar\",\n \"__init__(self, data, logger): self._data = data self.cursor = 0 self._logger = logger def\",\n \"= raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag,\",\n \"== b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies:\",\n \"for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data, jar, logger): p =\",\n \"= p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed\",\n \"with a key which is encrypted with DPAPI - not v10: encrypted with\",\n \"decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the end of the record')\",\n \"None: logger.error('safari does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform:\",\n \"cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies') secure_column = 'is_secure' if 'is_secure' in\",\n \"# EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext =\",\n \"with sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif\",\n \"= '' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies\",\n \"pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password, salt, iterations, key_length) def _decrypt_aes_cbc(ciphertext, key,\",\n \"kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query '\",\n \"to read from KWallet. kwallet-query should be' 'included in the kwallet package for\",\n \"YoutubeDLCookieJar() for jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is\",\n \"= { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft Edge' if sys.platform\",\n \"find safari cookies database') with open(cookies_path, 'rb') as f: cookies_data = f.read() jar\",\n \"DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for _\",\n \"== 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name]\",\n \"if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted, None return\",\n \"R'Microsoft\\\\Edge\\\\User Data'), 'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif\",\n \"we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col =\",\n \"human readable description of pDataIn None, # pOptionalEntropy: salt? None, # pvReserved: must\",\n \"--no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file =\",\n \"progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie:\",\n \"key derivation iterations than linux - not v10: 'old data' stored as plaintext\",\n \"+= 1 if self._v10_key is None: self._logger.warning('cannot decrypt v10 cookies: no key found',\",\n \"in page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment\",\n \"- cookies are either v10 or not v10 - v10: AES-CBC encrypted with\",\n \"os import shutil import struct import subprocess import sys import tempfile from datetime\",\n \"is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password):\",\n \"'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE':\",\n \"_find_most_recently_used_file(browser_root, 'Local State', logger) if path is None: logger.error('could not find local state\",\n \"record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between records') record_length\",\n \"*, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger)\",\n \"if cookie_file is not None: cookie_file = expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file,\",\n \"is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error']\",\n \"class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER = auto() CINNAMON = auto() GNOME\",\n \"if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password from kwallet. Using empty string\",\n \"that doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:] == b'\\\\n':\",\n \"return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if 'GNOME_DESKTOP_SESSION_ID' in env:\",\n \"logger): logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc = Popen(\",\n \"network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception as e: logger.warning(f'exception\",\n \"logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as\",\n \"sub classes') def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'):\",\n \"= decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if\",\n \"from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path,\",\n \"name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie\",\n \"decrypt v11 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger)\",\n \"expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format =\",\n \"\\\"\\\"\\\" Overview: Linux: - cookies are either v10 or v11 - v10: AES-CBC\",\n \"so the automatic detection # will not be sufficient in all cases. keyring\",\n \"ydl=None): self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message):\",\n \"def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property\",\n \".compat import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen,\",\n \"name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not value and encrypted_value\",\n \"def __init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name, logger) self._v10_key =\",\n \"browser_specification, ydl): cookie_jars = [] if browser_specification is not None: browser_name, profile, keyring\",\n \"salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version =\",\n \"desktop_session is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY\",\n \"logger): # if there are multiple browser profiles, take the most recently used\",\n \"Safe Storage'], # match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:]\",\n \"return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger):\",\n \".utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except\",\n \"R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform == 'darwin': appdata\",\n \"= auto() KDE = auto() PANTHEON = auto() UNITY = auto() XFCE =\",\n \"ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self, big_endian=False): data_format = '>I' if\",\n \"if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin':\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected desktop environment: {desktop_environment.name}') if desktop_environment ==\",\n \"-m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON =\",\n \"domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size\",\n \"record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset\",\n \"jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return jar finally: if cursor is not\",\n \"counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor is\",\n \"config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not\",\n \"names can be determined by snooping on dbus while opening the browser in\",\n \"_LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.cc SelectBackend \\\"\\\"\\\" desktop_environment = _get_linux_desktop_environment(os.environ) logger.debug(f'detected\",\n \"def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config = _config_home() browser_dir\",\n \"return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return network_wallet except Exception\",\n \"browser_name not in SUPPORTED_BROWSERS: raise ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in (None,\",\n \"_config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'),\",\n \"'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'), 'vivaldi': os.path.join(appdata,\",\n \"decrypt cookie (AES-CBC) because UTF-8 decoding failed. Possibly the key is wrong?', only_once=True)\",\n \"if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring =\",\n \"('linux', 'linux2'): config = _config_home() browser_dir = { 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config,\",\n \"self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if\",\n \"v10: 'old data' stored as plaintext Windows: - cookies are either v10 or\",\n \"browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}')\",\n \"ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config\",\n \"ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE:\",\n \"import compat_b64decode, compat_cookiejar_Cookie from .minicurses import MultilinePrinter, QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar,\",\n \"WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts\",\n \"logger.debug(f'Found local state file at \\\"{path}\\\"') with open(path, encoding='utf8') as f: data =\",\n \"\\\"type=method_return\\\" # while starting chrome. # this may be a bug as the\",\n \"install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the\",\n \"0 unencrypted_cookies = 0 with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count =\",\n \"else: self._cookie_counts['other'] += 1 # any other prefix means the data is DPAPI\",\n \"{sys.platform}') # Linux keyring names can be determined by snooping on dbus while\",\n \"LinuxChromeCookieDecryptor(browser_keyring_name, logger, keyring=keyring) elif sys.platform == 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform ==\",\n \"None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password = _get_mac_keyring_password(browser_keyring_name,\",\n \"read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes') end\",\n \"def expect_bytes(self, expected_value, message): value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected\",\n \"# pDataOut ) if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return\",\n \"instead # just tries to read the value (which kwallet returns \\\"\\\") whereas\",\n \"< 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self, offset, description='unknown'): self.skip(offset\",\n \"in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with\",\n \"cookies database in \\\"{search_root}\\\"') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger,\",\n \"end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain,\",\n \"to be out of date but the important parts of the database structure\",\n \"F841 try: p.skip_to(domain_offset) domain = p.read_cstring() p.skip_to(name_offset) name = p.read_cstring() p.skip_to(path_offset) path =\",\n \"p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True)\",\n \"the important parts of the database structure is the same - there are\",\n \"'must be installed to read from KWallet. kwallet-query should be' 'included in the\",\n \"elif keyring == _LinuxKeyring.GNOMEKEYRING: return _get_gnome_keyring_password(browser_keyring_name, logger) elif keyring == _LinuxKeyring.BASICTEXT: # when\",\n \"= [p.read_uint() for _ in range(number_of_cookies)] if number_of_cookies == 0: logger.debug(f'a cookies page\",\n \"QuietMultilinePrinter from .utils import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE =\",\n \"= os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not support profiles') search_root = config['browser_dir'] cookie_database_path\",\n \"self._cookie_counts['other'] += 1 return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger =\",\n \"= _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET:\",\n \"= auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET = auto() GNOMEKEYRING =\",\n \"else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in\",\n \"v10: AES-CBC encrypted with a fixed key - v11: AES-CBC encrypted with an\",\n \"logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return b'' def _get_gnome_keyring_password(browser_keyring_name, logger): if not SECRETSTORAGE_AVAILABLE: logger.error(f'secretstorage\",\n \"for item in col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else:\",\n \"shutil.which('kwallet-query') is None: logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be\",\n \"key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key, self._logger) else: self._cookie_counts['other'] += 1\",\n \"is_encrypted, compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure,\",\n \"p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset =\",\n \"version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version ==\",\n \"logger.error('could not find local state file') return None logger.debug(f'Found local state file at\",\n \"UNITY = auto() XFCE = auto() class _LinuxKeyring(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_util_linux.h SelectedLinuxBackend \\\"\\\"\\\" KWALLET\",\n \"try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part\",\n \"a context manager with a print method. (Optional)\\\"\\\"\\\" # Do not print to\",\n \"sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path):\",\n \"os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local,\",\n \"logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets =\",\n \"Popen( ['security', 'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name, # match\",\n \"\\\"\\\"\\\" from ctypes.wintypes import DWORD class DATA_BLOB(ctypes.Structure): _fields_ = [('cbData', DWORD), ('pbData', ctypes.POINTER(ctypes.c_char))]\",\n \"that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col\",\n \"BASICTEXT = auto() SUPPORTED_KEYRINGS = _LinuxKeyring.__members__.keys() def _get_linux_desktop_environment(env): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.cc GetDesktopEnvironment \\\"\\\"\\\" xdg_current_desktop\",\n \"a bug as the intended behaviour is to generate a random password and\",\n \"cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find safari\",\n \"SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = f'as the `secretstorage` module could not be initialized.\",\n \"return None class MacChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger): self._logger = logger password =\",\n \"_find_most_recently_used_file(search_root, 'cookies.sqlite', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find firefox cookies\",\n \"return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping\",\n \"return p.skip_to(record_offsets[0], 'unknown page header field') with _create_progress_bar(logger) as progress_bar: for i, record_offset\",\n \"os.path.join(appdata, 'Vivaldi'), }[browser_name] else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can\",\n \"domain_initial_dot=domain.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiration_date, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def\",\n \"jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this\",\n \"'vivaldi': 'Vivaldi' if sys.platform == 'darwin' else 'Chrome', }[browser_name] browsers_without_profiles = {'opera'} return\",\n \"with _create_progress_bar(logger) as progress_bar: for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies:\",\n \"_LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop == 'GNOME': return _LinuxDesktopEnvironment.GNOME elif xdg_current_desktop ==\",\n \"list. It appears that we must do the same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init())\",\n \"https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/ - [2] https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/key_storage_linux.cc - KeyStorageLinux::CreateService \\\"\\\"\\\" def decrypt(self, encrypted_value): raise NotImplementedError('Must be\",\n \"elif desktop_environment == _LinuxDesktopEnvironment.OTHER: linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring\",\n \"password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is None else\",\n \"QuietMultilinePrinter() printer.print = lambda _: None return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars\",\n \"= False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not installed. '\",\n \"host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies\",\n \"logger): self._data = data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes):\",\n \"= _get_kwallet_network_wallet(logger) try: proc = Popen([ 'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name}\",\n \"is not None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif\",\n \"else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar\",\n \"'kwallet-query', '--read-password', f'{browser_keyring_name} Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout,\",\n \"import shutil import struct import subprocess import sys import tempfile from datetime import\",\n \"pass class DataParser: def __init__(self, data, logger): self._data = data self.cursor = 0\",\n \"def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to\",\n \"= None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor,\",\n \"platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name): # https://chromium.googlesource.com/chromium/src/+/HEAD/docs/user_data_dir.md if sys.platform in ('linux', 'linux2'): config =\",\n \"'kde' in desktop_session: return _LinuxDesktopEnvironment.KDE elif 'xfce' in desktop_session: return _LinuxDesktopEnvironment.XFCE else: if\",\n \"store # it, but that doesn't matter here. return b'' else: logger.debug('password found')\",\n \"to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet = \\\"{network_wallet}\\\"') return\",\n \"number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)} has no cookies') return\",\n \"16 raw_ciphertext = ciphertext nonce = raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:]\",\n \"files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths\",\n \"'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary\",\n \"def get_cookie_decryptor(browser_root, browser_keyring_name, logger, *, keyring=None): if sys.platform in ('linux', 'linux2'): return LinuxChromeCookieDecryptor(browser_keyring_name,\",\n \"* 16): plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed\",\n \"filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda path: os.lstat(path).st_mtime)\",\n \"if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) elif version\",\n \"'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return pbkdf2_sha1(password, salt=b'<PASSWORD>',\",\n \"1 # any other prefix means the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc\",\n \"import secretstorage SECRETSTORAGE_AVAILABLE = True except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = (\",\n \"def _get_kwallet_password(browser_keyring_name, logger): logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is\",\n \"can be run with the following flags to determine which keyring backend #\",\n \"paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in\",\n \"+= 1 if self._v11_key is None: self._logger.warning('cannot decrypt v11 cookies: no key found',\",\n \"'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local =\",\n \"startup, it can be observed that chromium lists all keys # and presumably\",\n \"it, but that doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:]\",\n \"path.decode('utf-8') is_encrypted = not value and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if\",\n \"AES-GCM encrypted with a key which is encrypted with DPAPI - not v10:\",\n \"library, it is possible to compile python without # sqlite support. See: https://github.com/yt-dlp/yt-dlp/issues/544\",\n \"logger): if profile is not None: logger.error('safari does not support profiles') if sys.platform\",\n \"'safari'} class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message): if\",\n \"'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local\",\n \"password from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', # write\",\n \"self._logger = logger def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read\",\n \"return None return _decrypt_windows_dpapi(encrypted_key[len(prefix):], logger) def pbkdf2_sha1(password, salt, iterations, key_length): return pbkdf2_hmac('sha1', password,\",\n \"from firefox') return jar finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir():\",\n \"cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name, value, path,\",\n \"but the important parts of the database structure is the same - there\",\n \"database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor() def _get_column_names(cursor,\",\n \"in {search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None\",\n \"cookies are either v10 or not v10 - v10: AES-CBC encrypted with an\",\n \"running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root, 'Local State',\",\n \"desktop environment: {desktop_environment.name}') if desktop_environment == _LinuxDesktopEnvironment.KDE: linux_keyring = _LinuxKeyring.KWALLET elif desktop_environment ==\",\n \"pDataOut ) if not ret: logger.warning('failed to decrypt with DPAPI', only_once=True) return None\",\n \"could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome', 'chromium', 'edge', 'opera', 'vivaldi'}\",\n \"elif browser_name in CHROMIUM_BASED_BROWSERS: return _extract_chrome_cookies(browser_name, profile, keyring, logger) else: raise ValueError(f'unknown browser:\",\n \"'find-generic-password', '-w', # write password to stdout '-a', browser_keyring_name, # match 'account' '-s',\",\n \"as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT host, name,\",\n \"linux_keyring = _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The\",\n \"return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER def _choose_linux_keyring(logger): \\\"\\\"\\\"\",\n \"os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir): # cannot open sqlite databases if they are\",\n \"os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = { 'brave': os.path.join(appdata_local, R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local,\",\n \"linux - not v10: 'old data' stored as plaintext Windows: - cookies are\",\n \"as plaintext Windows: - cookies are either v10 or not v10 - v10:\",\n \"for details') return b'' else: if stdout.lower().startswith(b'failed to read'): logger.debug('failed to read password\",\n \"elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%') browser_dir = {\",\n \"data self.cursor = 0 self._logger = logger def read_bytes(self, num_bytes): if num_bytes <\",\n \"bytes') def skip_to(self, offset, description='unknown'): self.skip(offset - self.cursor, description) def skip_to_end(self, description='unknown'): self.skip_to(len(self._data),\",\n \"for i, record_offset in enumerate(record_offsets): progress_bar.print(f'Loading cookie {i: 6d}/{number_of_cookies: 6d}') p.skip_to(record_offset, 'space between\",\n \"keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir)\",\n \"loggers, or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'):\",\n \"return _merge_cookie_jars(cookie_jars) def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return\",\n \"v10 or not v10 - v10: AES-GCM encrypted with a key which is\",\n \"if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod\",\n \"record_length = _parse_safari_cookies_record(data[record_offset:], jar, logger) p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar,\",\n \"and instead # just tries to read the value (which kwallet returns \\\"\\\")\",\n \"to obtain password from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w',\",\n \"the data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger):\",\n \"if failed_cookies > 0: failed_message = f' ({failed_cookies} could not be decrypted)' else:\",\n \"{'v10': 0, 'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from #\",\n \"return None result = ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME',\",\n \"# checks hasEntry. To verify this: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" # while starting\",\n \"import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is part of\",\n \"during parsing \\\"\\\"\\\" if jar is None: jar = YoutubeDLCookieJar() page_sizes, body_start =\",\n \"if not cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1\",\n \"the key is wrong?', only_once=True) return None def _decrypt_windows_dpapi(ciphertext, logger): \\\"\\\"\\\" References: -\",\n \"= logger self._v10_key = self.derive_key(b'peanuts') password = _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None\",\n \"it can be observed that chromium lists all keys # and presumably searches\",\n \"if not SQLITE_AVAILABLE: logger.warning('Cannot extract cookies from firefox without sqlite3 support. ' 'Please\",\n \"not support profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path\",\n \"only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a context manager\",\n \"value = self.read_bytes(len(expected_value)) if value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value}\",\n \"stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code\",\n \"def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet used to store network passwords.\",\n \"_LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE\",\n \"files/pipes, loggers, or when --no-progress is used if not self._ydl or self._ydl.params.get('noprogress') or\",\n \"print to files/pipes, loggers, or when --no-progress is used if not self._ydl or\",\n \"encrypted_value, path, expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies\",\n \"return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet used to store\",\n \"linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name of the wallet used to store network\",\n \"p.read_uint(big_endian=True) page_sizes = [p.read_uint(big_endian=True) for _ in range(number_of_pages)] return page_sizes, p.cursor def _parse_safari_cookies_page(data,\",\n \"path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from\",\n \"KDE: # dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium':\",\n \"raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie\",\n \"self._logger.warning('cannot decrypt v11 cookies: no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v11_key,\",\n \"field 2') domain_offset = p.read_uint() name_offset = p.read_uint() path_offset = p.read_uint() value_offset =\",\n \"blob_in = DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn\",\n \"== _LinuxKeyring.BASICTEXT: # when basic text is chosen, all cookies are stored as\",\n \"_extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE: logger.warning(f'Cannot extract\",\n \"paths else max(paths, key=lambda path: os.lstat(path).st_mtime) def _merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar\",\n \"if value != expected_value: raise ParserError(f'unexpected value: {value} != {expected_value} ({message})') def read_uint(self,\",\n \"file in files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\": {i: 6d} files searched')\",\n \"for i, (host, name, value, path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i:\",\n \"sqlite databases if they are already in use (e.g. by the browser) database_copy_path\",\n \"and encrypted_value if is_encrypted: value = decryptor.decrypt(encrypted_value) if value is None: return is_encrypted,\",\n \"cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue elif not\",\n \"= _get_linux_keyring_password(browser_keyring_name, keyring, logger) self._v11_key = None if password is None else self.derive_key(password)\",\n \"Safe Storage': return item.get_secret() else: logger.error('failed to read from keyring') return b'' def\",\n \"import Popen, YoutubeDLCookieJar, error_to_str, expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError:\",\n \"f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password from OSX\",\n \"({message})') def read_uint(self, big_endian=False): data_format = '>I' if big_endian else '<I' return struct.unpack(data_format,\",\n \"detection # will not be sufficient in all cases. keyring = _LinuxKeyring[keyring] if\",\n \"profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}') cookies_path = os.path.expanduser('~/Library/Cookies/Cookies.binarycookies') if\",\n \"jar finally: if cursor is not None: cursor.connection.close() def _firefox_browser_dir(): if sys.platform in\",\n \"pbkdf2_sha1(password, salt=b'<PASSWORD>', iterations=1, key_length=16) @property def cookie_counts(self): return self._cookie_counts def decrypt(self, encrypted_value): version\",\n \"is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if failed_cookies > 0: failed_message = f' ({failed_cookies}\",\n \"return _extract_firefox_cookies(profile, logger) elif browser_name == 'safari': return _extract_safari_cookies(profile, logger) elif browser_name in\",\n \"a flag: --password-store=<basic|gnome|kwallet> so the automatic detection # will not be sufficient in\",\n \"cookies from firefox') return jar finally: if cursor is not None: cursor.connection.close() def\",\n \"subprocess import sys import tempfile from datetime import datetime, timedelta, timezone from enum\",\n \"data is DPAPI encrypted # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_win.cc return _decrypt_windows_dpapi(encrypted_value, self._logger).decode('utf-8') def _extract_safari_cookies(profile, logger): if\",\n \"DataParser(data, logger) record_size = p.read_uint() p.skip(4, 'unknown record field 1') flags = p.read_uint()\",\n \"stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except\",\n \"'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile,\",\n \"except ImportError: SECRETSTORAGE_AVAILABLE = False SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is\",\n \"browsers_without_profiles } def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not\",\n \"jar.filename is not None: output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep\",\n \"_find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None: raise FileNotFoundError(f'could not find {browser_name} cookies\",\n \"if number_of_cookies == 0: logger.debug(f'a cookies page of size {len(data)} has no cookies')\",\n \"p.read_bytes(record_length) p.skip_to_end('space in between pages') def _parse_safari_cookies_record(data, jar, logger): p = DataParser(data, logger)\",\n \"= encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger)\",\n \"else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring == _LinuxKeyring.KWALLET: return _get_kwallet_password(browser_keyring_name, logger) elif\",\n \"info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message, only_once=False): if self._ydl: self._ydl.report_warning(message,\",\n \"cannot open sqlite databases if they are already in use (e.g. by the\",\n \"_merge_cookie_jars(jars): output_jar = YoutubeDLCookieJar() for jar in jars: for cookie in jar: output_jar.set_cookie(cookie)\",\n \"self.derive_key(password) self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from\",\n \"kwallet-query ' 'must be installed to read from KWallet. kwallet-query should be' 'included\",\n \"Gnome keyring does not seem to organise keys in the same way as\",\n \"big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self): buffer = [] while True:\",\n \"match 'service' stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if stdout[-1:] == b'\\\\n': stdout\",\n \"if c == b'\\\\x00': return b''.join(buffer).decode('utf-8') else: buffer.append(c) def skip(self, num_bytes, description='unknown'): if\",\n \"cursor is not None: cursor.connection.close() def _process_chrome_cookie(decryptor, host_key, name, value, encrypted_value, path, expires_utc,\",\n \"ValueError(f'unsupported browser: \\\"{browser_name}\\\"') if keyring not in (None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"')\",\n \"plaintext = unpad_pkcs7(aes_cbc_decrypt_bytes(ciphertext, key, initialization_vector)) try: return plaintext.decode('utf-8') except UnicodeDecodeError: logger.warning('failed to decrypt\",\n \"found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 #\",\n \"raw_ciphertext[:nonce_length] ciphertext = raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger)\",\n \"same. # https://github.com/jaraco/keyring/issues/556 with contextlib.closing(secretstorage.dbus_init()) as con: col = secretstorage.get_default_collection(con) for item in\",\n \"__init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key = self.derive_key(b'peanuts') password =\",\n \"raw_ciphertext[nonce_length:-authentication_tag_length] authentication_tag = raw_ciphertext[-authentication_tag_length:] return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] +=\",\n \"def __init__(self, browser_root, logger): self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts =\",\n \"secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise FileNotFoundError('could not find\",\n \"tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory =\",\n \"from OSX keychain') try: proc = Popen( ['security', 'find-generic-password', '-w', # write password\",\n \"are already in use (e.g. by the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path,\",\n \"6d} files searched') if file == filename: paths.append(os.path.join(curr_root, file)) return None if not\",\n \"environment [2] Mac: - cookies are either v10 or not v10 - v10:\",\n \"def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies =\",\n \"- https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out of date but the\",\n \"not self._ydl or self._ydl.params.get('noprogress') or self._ydl.params.get('logger'): return file = self._ydl._out_files['error'] try: if not\",\n \"= proc.communicate_or_kill() if proc.returncode != 0: logger.warning('failed to read NetworkWallet') return default_wallet else:\",\n \"_LinuxDesktopEnvironment.XFCE elif desktop_session is not None: if desktop_session in ('mate', 'gnome'): return _LinuxDesktopEnvironment.GNOME\",\n \"if file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths,\",\n \"return _decrypt_aes_gcm(ciphertext, self._v10_key, nonce, authentication_tag, self._logger) else: self._cookie_counts['other'] += 1 # any other\",\n \"the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=domain, domain_specified=bool(domain), domain_initial_dot=domain.startswith('.'),\",\n \"empty string instead') # this sometimes occurs in KDE because chrome does not\",\n \"a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if\",\n \"with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, (host,\",\n \"compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc,\",\n \"= config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] = os.path.dirname(profile) if config['supports_profiles'] else\",\n \"{ 'brave': os.path.join(config, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(config, 'google-chrome'), 'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'),\",\n \"version = encrypted_value[:3] ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1\",\n \"big_endian=False): data_format = '>d' if big_endian else '<d' return struct.unpack(data_format, self.read_bytes(8))[0] def read_cstring(self):\",\n \"'old data' stored as plaintext Windows: - cookies are either v10 or not\",\n \"Storage': return item.get_secret() else: logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name,\",\n \"cookies database') with open(cookies_path, 'rb') as f: cookies_data = f.read() jar = parse_safari_cookies(cookies_data,\",\n \"port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={})\",\n \"protected key (keyring) - v11 keys can be stored in various places depending\",\n \"YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root = config['browser_dir'] elif _is_path(profile):\",\n \"KWallet, # using `dbus-monitor` during startup, it can be observed that chromium lists\",\n \"a fixed key - v11: AES-CBC encrypted with an OS protected key (keyring)\",\n \"standard library, it is possible to compile python without # sqlite support. See:\",\n \"'' logger.info(f'Extracted {len(jar)} cookies from {browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie\",\n \"xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON elif xdg_current_desktop == 'XFCE': return _LinuxDesktopEnvironment.XFCE elif desktop_session\",\n \"p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError: logger.warning('failed to parse Safari cookie because UTF-8\",\n \"os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%') appdata_roaming = os.path.expandvars('%APPDATA%')\",\n \"is None: self._logger.warning('cannot decrypt v10 cookies: no key found', only_once=True) return None return\",\n \"& 0x0001) p.skip(4, 'unknown record field 2') domain_offset = p.read_uint() name_offset = p.read_uint()\",\n \"col.get_all_items(): if item.get_label() == f'{browser_keyring_name} Safe Storage': return item.get_secret() else: logger.error('failed to read\",\n \"prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if not ret:\",\n \"profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name\",\n \"= 'is_secure' if 'is_secure' in column_names else 'secure' cursor.execute(f'SELECT host_key, name, value, encrypted_value,\",\n \"self._logger = logger self._v10_key = _get_windows_v10_key(browser_root, logger) self._cookie_counts = {'v10': 0, 'other': 0}\",\n \"flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown record field 2')\",\n \"is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is\",\n \"stdout except Exception as e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root,\",\n \"install by running `python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE\",\n \"(keyring) and more key derivation iterations than linux - not v10: 'old data'\",\n \"if stdout[-1:] == b'\\\\n': stdout = stdout[:-1] return stdout except Exception as e:\",\n \"secure=is_secure, expires=expiry, discard=False, comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) logger.info(f'Extracted {len(jar)} cookies from firefox') return\",\n \"line in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line)\",\n \"keyring password is required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name,\",\n \"__init__(self, ydl=None): self._ydl = ydl def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self,\",\n \"= get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try:\",\n \"'chromium': os.path.join(config, 'chromium'), 'edge': os.path.join(config, 'microsoft-edge'), 'opera': os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name]\",\n \"with an OS protected key (keyring) and more key derivation iterations than linux\",\n \"None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names = _get_column_names(cursor, 'cookies')\",\n \"cookie decryption is not supported on this platform: {sys.platform}') class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self,\",\n \"({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def\",\n \"= DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None, # ppszDataDescr: human readable\",\n \"# dbus-monitor \\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium',\",\n \"'GNOME_DESKTOP_SESSION_ID' in env: return _LinuxDesktopEnvironment.GNOME elif 'KDE_FULL_SESSION' in env: return _LinuxDesktopEnvironment.KDE return _LinuxDesktopEnvironment.OTHER\",\n \"= {'opera'} return { 'browser_dir': browser_dir, 'keyring_name': keyring_name, 'supports_profiles': browser_name not in browsers_without_profiles\",\n \"def debug(self, message): if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}')\",\n \"p.skip_to(record_size, 'space at the end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name,\",\n \"doesn't matter here. return b'' else: logger.debug('password found') if stdout[-1:] == b'\\\\n': stdout\",\n \"value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as progress_bar:\",\n \"key (keyring) and more key derivation iterations than linux - not v10: 'old\",\n \"} def _extract_chrome_cookies(browser_name, profile, keyring, logger): logger.info(f'Extracting cookies from {browser_name}') if not SQLITE_AVAILABLE:\",\n \"= stdout[:-1] return stdout except Exception as e: logger.warning(f'exception running kwallet-query: {error_to_str(e)}') return\",\n \"name = p.read_cstring() p.skip_to(path_offset) path = p.read_cstring() p.skip_to(value_offset) value = p.read_cstring() except UnicodeDecodeError:\",\n \"= DATA_BLOB(ctypes.sizeof(buffer), buffer) blob_out = DATA_BLOB() ret = ctypes.windll.crypt32.CryptUnprotectData( ctypes.byref(blob_in), # pDataIn None,\",\n \"Linux keyring names can be determined by snooping on dbus while opening the\",\n \"p.cursor def _parse_safari_cookies_page(data, jar, logger): p = DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies\",\n \"cookie {i: 6d}/{total_cookie_count: 6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies\",\n \"chosen to use # chromium --enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium\",\n \"not os.path.isfile(cookies_path): logger.debug('Trying secondary cookie location') cookies_path = os.path.expanduser('~/Library/Containers/com.apple.Safari/Data/Library/Cookies/Cookies.binarycookies') if not os.path.isfile(cookies_path): raise\",\n \"0: logger.warning('failed to read NetworkWallet') return default_wallet else: network_wallet = stdout.decode('utf-8').strip() logger.debug(f'NetworkWallet =\",\n \"proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed with return code {proc.returncode}. Please consult\",\n \"ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not None and _is_path(profile): profile = os.path.expanduser(profile)\",\n \"ParserError('reached end of input') data = self._data[self.cursor:end] self.cursor = end return data def\",\n \"Safe Storage', '--folder', f'{browser_keyring_name} Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill()\",\n \"KDE = auto() PANTHEON = auto() UNITY = auto() XFCE = auto() class\",\n \"cases. keyring = _LinuxKeyring[keyring] if keyring else _choose_linux_keyring(logger) logger.debug(f'Chosen keyring: {keyring.name}') if keyring\",\n \"_create_progress_bar(logger) as progress_bar: for curr_root, dirs, files in os.walk(root): for file in files:\",\n \"class YDLLogger: def __init__(self, ydl=None): self._ydl = ydl def debug(self, message): if self._ydl:\",\n \"files in os.walk(root): for file in files: i += 1 progress_bar.print(f'Searching for \\\"{filename}\\\":\",\n \"return printer def load_cookies(cookie_file, browser_specification, ydl): cookie_jars = [] if browser_specification is not\",\n \"= expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars)\",\n \"if sys.platform in ('linux', 'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles')\",\n \"num_bytes, description='unknown'): if num_bytes > 0: self._logger.debug(f'skipping {num_bytes} bytes ({description}): {self.read_bytes(num_bytes)!r}') elif num_bytes\",\n \"self._ydl: self._ydl.report_warning(message, only_once) def error(self, message): if self._ydl: self._ydl.report_error(message) def progress_bar(self): \\\"\\\"\\\"Return a\",\n \"output_jar.filename = jar.filename return output_jar def _is_path(value): return os.path.sep in value def _parse_browser_specification(browser_name,\",\n \"datetime import datetime, timedelta, timezone from enum import Enum, auto from hashlib import\",\n \"_decrypt_aes_gcm(ciphertext, key, nonce, authentication_tag, logger): try: plaintext = aes_gcm_decrypt_and_verify_bytes(ciphertext, key, authentication_tag, nonce) except\",\n \"OS protected key (keyring) - v11 keys can be stored in various places\",\n \"None and 'gnome-fallback' in desktop_session: return _LinuxDesktopEnvironment.GNOME else: return _LinuxDesktopEnvironment.UNITY elif xdg_current_desktop ==\",\n \"'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata, 'Chromium'), 'edge': os.path.join(appdata, 'Microsoft Edge'), 'opera': os.path.join(appdata, 'com.operasoftware.Opera'),\",\n \"{search_root}') logger.debug(f'Extracting cookies from: \\\"{cookie_database_path}\\\"') with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try:\",\n \"decryptor = get_cookie_decryptor(config['browser_dir'], config['keyring_name'], logger, keyring=keyring) with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None\",\n \"path, expiry, is_secure) in enumerate(table): progress_bar.print(f'Loading cookie {i: 6d}/{total_cookie_count: 6d}') cookie = compat_cookiejar_Cookie(\",\n \"return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger = logger self._v10_key =\",\n \"logger): p = DataParser(data, logger) p.expect_bytes(b'cook', 'database signature') number_of_pages = p.read_uint(big_endian=True) page_sizes =\",\n \"host_key.decode('utf-8') name = name.decode('utf-8') value = value.decode('utf-8') path = path.decode('utf-8') is_encrypted = not\",\n \"as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger): self._logger\",\n \"'the kwallet-query man page for details') return b'' else: if stdout.lower().startswith(b'failed to read'):\",\n \"{'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return\",\n \"profile is None: search_root = config['browser_dir'] elif _is_path(profile): search_root = profile config['browser_dir'] =\",\n \"no key found', only_once=True) return None return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] +=\",\n \"without sqlite3 support. ' 'Please use a python interpreter compiled with sqlite3 support')\",\n \"with _create_progress_bar(logger) as progress_bar: table = cursor.fetchall() total_cookie_count = len(table) for i, line\",\n \"logger.error('kwallet-query command not found. KWallet and kwallet-query ' 'must be installed to read\",\n \"browser profiles, take the most recently used one i, paths = 0, []\",\n \"logger.debug('using find-generic-password to obtain password from OSX keychain') try: proc = Popen( ['security',\",\n \"logger.debug('failed to read password from kwallet. Using empty string instead') # this sometimes\",\n \"jar in jars: for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None:\",\n \"profile, keyring, logger) else: raise ValueError(f'unknown browser: {browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies\",\n \"= _LinuxKeyring.BASICTEXT else: linux_keyring = _LinuxKeyring.GNOMEKEYRING return linux_keyring def _get_kwallet_network_wallet(logger): \\\"\\\"\\\" The name\",\n \"tmpdir) cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar()\",\n \"ciphertext = encrypted_value[3:] if version == b'v10': self._cookie_counts['v10'] += 1 if self._v10_key is\",\n \"logger.debug('using kwallet-query to obtain password from kwallet') if shutil.which('kwallet-query') is None: logger.error('kwallet-query command\",\n \"_get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with the following flags\",\n \"is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0, 'other': 0} @staticmethod\",\n \"cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.connection.text_factory = bytes column_names =\",\n \"for cookie in jar: output_jar.set_cookie(cookie) if jar.filename is not None: output_jar.filename = jar.filename\",\n \"cookie_jars = [] if browser_specification is not None: browser_name, profile, keyring = _parse_browser_specification(*browser_specification)\",\n \"row in table_info] def _find_most_recently_used_file(root, filename, logger): # if there are multiple browser\",\n \"{browser_name}') def _extract_firefox_cookies(profile, logger): logger.info('Extracting cookies from firefox') if not SQLITE_AVAILABLE: logger.warning('Cannot extract\",\n \"'Chromium', 'opera': 'Opera' if sys.platform == 'darwin' else 'Chromium', 'vivaldi': 'Vivaldi' if sys.platform\",\n \"information about prompts to display 0, # dwFlags ctypes.byref(blob_out) # pDataOut ) if\",\n \"else: raise ValueError(f'unsupported platform: {sys.platform}') # Linux keyring names can be determined by\",\n \"(None, *SUPPORTED_KEYRINGS): raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not None and _is_path(profile):\",\n \"cursor.execute('SELECT host, name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with\",\n \"profiles') search_root = config['browser_dir'] cookie_database_path = _find_most_recently_used_file(search_root, 'Cookies', logger) if cookie_database_path is None:\",\n \"either v10 or not v10 - v10: AES-CBC encrypted with an OS protected\",\n \"= auto() GNOME = auto() KDE = auto() PANTHEON = auto() UNITY =\",\n \"comment=None, comment_url=None, rest={}) jar.set_cookie(cookie) return record_size def parse_safari_cookies(data, jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: -\",\n \"v10 - v10: AES-GCM encrypted with a key which is encrypted with DPAPI\",\n \"stored as plaintext # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_mac.mm return encrypted_value class WindowsChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_root, logger):\",\n \"logger.error('safari does not support profiles') if sys.platform != 'darwin': raise ValueError(f'unsupported platform: {sys.platform}')\",\n \"SECRETSTORAGE_UNAVAILABLE_REASON = ( 'as the `secretstorage` module is not installed. ' 'Please install\",\n \"'linux2'): return os.path.expanduser('~/.mozilla/firefox') elif sys.platform == 'win32': return os.path.expandvars(R'%APPDATA%\\\\Mozilla\\\\Firefox\\\\Profiles') elif sys.platform == 'darwin':\",\n \"_parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\" OTHER\",\n \"= auto() CINNAMON = auto() GNOME = auto() KDE = auto() PANTHEON =\",\n \"page_sizes: _parse_safari_cookies_page(p.read_bytes(page_size), jar, logger) p.skip_to_end('footer') return jar class _LinuxDesktopEnvironment(Enum): \\\"\\\"\\\" https://chromium.googlesource.com/chromium/src/+/refs/heads/main/base/nix/xdg_util.h DesktopEnvironment \\\"\\\"\\\"\",\n \"'progress_bar'): printer = logger.progress_bar() if printer: return printer printer = QuietMultilinePrinter() printer.print =\",\n \"' 'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar() config\",\n \"the `secretstorage` module is not installed. ' 'Please install by running `python3 -m\",\n \"Keys', network_wallet ], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0:\",\n \"extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif\",\n \"else profile else: if config['supports_profiles']: search_root = os.path.join(config['browser_dir'], profile) else: logger.error(f'{browser_name} does not\",\n \"expand_path(cookie_file) jar = YoutubeDLCookieJar(cookie_file) if os.access(cookie_file, os.R_OK): jar.load(ignore_discard=True, ignore_expires=True) cookie_jars.append(jar) return _merge_cookie_jars(cookie_jars) def\",\n \"e: logger.warning(f'exception running find-generic-password: {error_to_str(e)}') return None def _get_windows_v10_key(browser_root, logger): path = _find_most_recently_used_file(browser_root,\",\n \"name=name, value=value, port=None, port_specified=False, domain=host_key, domain_specified=bool(host_key), domain_initial_dot=host_key.startswith('.'), path=path, path_specified=bool(path), secure=is_secure, expires=expires_utc, discard=False, comment=None,\",\n \"class LinuxChromeCookieDecryptor(ChromeCookieDecryptor): def __init__(self, browser_keyring_name, logger, *, keyring=None): self._logger = logger self._v10_key =\",\n \"one i, paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root, dirs,\",\n \"name, value, path, expiry, isSecure FROM moz_cookies') jar = YoutubeDLCookieJar() with _create_progress_bar(logger) as\",\n \"record field 1') flags = p.read_uint() is_secure = bool(flags & 0x0001) p.skip(4, 'unknown\",\n \"with tempfile.TemporaryDirectory(prefix='yt_dlp') as tmpdir: cursor = None try: cursor = _open_database_copy(cookie_database_path, tmpdir) cursor.execute('SELECT\",\n \"6d}') is_encrypted, cookie = _process_chrome_cookie(decryptor, *line) if not cookie: failed_cookies += 1 continue\",\n \"], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) stdout, stderr = proc.communicate_or_kill() if proc.returncode != 0: logger.error(f'kwallet-query failed\",\n \"return _decrypt_aes_cbc(ciphertext, self._v10_key, self._logger) else: self._cookie_counts['other'] += 1 # other prefixes are considered\",\n \"\\\"interface='org.kde.KWallet'\\\" \\\"type=method_return\\\" keyring_name = { 'brave': 'Brave', 'chrome': 'Chrome', 'chromium': 'Chromium', 'edge': 'Microsoft\",\n \"env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop ==\",\n \"_LinuxDesktopEnvironment.CINNAMON elif xdg_current_desktop == 'KDE': return _LinuxDesktopEnvironment.KDE elif xdg_current_desktop == 'Pantheon': return _LinuxDesktopEnvironment.PANTHEON\",\n \"by running `python3 -m pip install secretstorage`.') except Exception as _err: SECRETSTORAGE_AVAILABLE =\",\n \"profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None: cookie_file = expand_path(cookie_file) jar =\",\n \"= xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session is not None and 'gnome-fallback'\",\n \"'v11': 0, 'other': 0} @staticmethod def derive_key(password): # values from # https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/os_crypt_linux.cc return\",\n \"store network passwords. https://chromium.googlesource.com/chromium/src/+/refs/heads/main/components/os_crypt/kwallet_dbus.cc KWalletDBus::NetworkWallet which does a dbus call to the following\",\n \"def read_bytes(self, num_bytes): if num_bytes < 0: raise ParserError(f'invalid read of {num_bytes} bytes')\",\n \"buffer = [] while True: c = self.read_bytes(1) if c == b'\\\\x00': return\",\n \"None if password is None else self.derive_key(password) self._cookie_counts = {'v10': 0, 'v11': 0,\",\n \"96 // 8 # boringssl # EVP_AEAD_AES_GCM_TAG_LEN authentication_tag_length = 16 raw_ciphertext = ciphertext\",\n \"raise FileNotFoundError('could not find safari cookies database') with open(cookies_path, 'rb') as f: cookies_data\",\n \"bytes') end = self.cursor + num_bytes if end > len(self._data): raise ParserError('reached end\",\n \"Safari cookie because UTF-8 decoding failed', only_once=True) return record_size p.skip_to(record_size, 'space at the\",\n \"ctypes.string_at(blob_out.pbData, blob_out.cbData) ctypes.windll.kernel32.LocalFree(blob_out.pbData) return result def _config_home(): return os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) def _open_database_copy(database_path, tmpdir):\",\n \"def extract_cookies_from_browser(browser_name, profile=None, logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger)\",\n \"R'BraveSoftware\\\\Brave-Browser\\\\User Data'), 'chrome': os.path.join(appdata_local, R'Google\\\\Chrome\\\\User Data'), 'chromium': os.path.join(appdata_local, R'Chromium\\\\User Data'), 'edge': os.path.join(appdata_local, R'Microsoft\\\\Edge\\\\User\",\n \"== 'darwin': return MacChromeCookieDecryptor(browser_keyring_name, logger) elif sys.platform == 'win32': return WindowsChromeCookieDecryptor(browser_root, logger) else:\",\n \"there are a few bytes here and there which are skipped during parsing\",\n \"xdg_current_desktop is not None: xdg_current_desktop = xdg_current_desktop.split(':')[0].strip() if xdg_current_desktop == 'Unity': if desktop_session\",\n \"= DataParser(data, logger) p.expect_bytes(b'\\\\x00\\\\x00\\\\x01\\\\x00', 'page signature') number_of_cookies = p.read_uint() record_offsets = [p.read_uint() for\",\n \"raise ValueError(f'unsupported keyring: \\\"{keyring}\\\"') if profile is not None and _is_path(profile): profile =\",\n \"logger=YDLLogger(), *, keyring=None): if browser_name == 'firefox': return _extract_firefox_cookies(profile, logger) elif browser_name ==\",\n \"sqlite3 support') return YoutubeDLCookieJar() config = _get_chromium_based_browser_settings(browser_name) if profile is None: search_root =\",\n \"{self.read_bytes(num_bytes)!r}') elif num_bytes < 0: raise ParserError(f'invalid skip of {num_bytes} bytes') def skip_to(self,\",\n \"YoutubeDLCookieJar() page_sizes, body_start = _parse_safari_cookies_header(data, logger) p = DataParser(data[body_start:], logger) for page_size in\",\n \"note: chrome/chromium can be run with the following flags to determine which keyring\",\n \"file == filename: paths.append(os.path.join(curr_root, file)) return None if not paths else max(paths, key=lambda\",\n \"FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0 with _create_progress_bar(logger)\",\n \"self._cookie_counts = {'v10': 0, 'other': 0} @staticmethod def derive_key(password): # values from #\",\n \"'space at the end of the record') cookie = compat_cookiejar_Cookie( version=0, name=name, value=value,\",\n \"just tries to read the value (which kwallet returns \\\"\\\") whereas kwallet-query #\",\n \"timezone from enum import Enum, auto from hashlib import pbkdf2_hmac from .aes import\",\n \"logger.error('failed to read from keyring') return b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note:\",\n \"local state file at \\\"{path}\\\"') with open(path, encoding='utf8') as f: data = json.load(f)\",\n \"b'' def _get_linux_keyring_password(browser_keyring_name, keyring, logger): # note: chrome/chromium can be run with the\",\n \"keyring does not seem to organise keys in the same way as KWallet,\",\n \"support. ' 'Please use a python interpreter compiled with sqlite3 support') return YoutubeDLCookieJar()\",\n \"os.path.expanduser('~/Library/Application Support') browser_dir = { 'brave': os.path.join(appdata, 'BraveSoftware/Brave-Browser'), 'chrome': os.path.join(appdata, 'Google/Chrome'), 'chromium': os.path.join(appdata,\",\n \"encrypted with an OS protected key (keyring) - v11 keys can be stored\",\n \"the browser) database_copy_path = os.path.join(tmpdir, 'temporary.sqlite') shutil.copy(database_path, database_copy_path) conn = sqlite3.connect(database_copy_path) return conn.cursor()\",\n \"input') data = self._data[self.cursor:end] self.cursor = end return data def expect_bytes(self, expected_value, message):\",\n \"logger): # note: chrome/chromium can be run with the following flags to determine\",\n \"expand_path try: import sqlite3 SQLITE_AVAILABLE = True except ImportError: # although sqlite3 is\",\n \"sqlite3 support') return YoutubeDLCookieJar() if profile is None: search_root = _firefox_browser_dir() elif _is_path(profile):\",\n \"os.path.join(config, 'opera'), 'vivaldi': os.path.join(config, 'vivaldi'), }[browser_name] elif sys.platform == 'win32': appdata_local = os.path.expandvars('%LOCALAPPDATA%')\",\n \"profile, keyring = _parse_browser_specification(*browser_specification) cookie_jars.append(extract_cookies_from_browser(browser_name, profile, YDLLogger(ydl), keyring=keyring)) if cookie_file is not None:\",\n \"'opera': os.path.join(appdata_roaming, R'Opera Software\\\\Opera Stable'), 'vivaldi': os.path.join(appdata_local, R'Vivaldi\\\\User Data'), }[browser_name] elif sys.platform ==\",\n \"expires_utc, {secure_column} FROM cookies') jar = YoutubeDLCookieJar() failed_cookies = 0 unencrypted_cookies = 0\",\n \"\\\"\\\"\\\" xdg_current_desktop = env.get('XDG_CURRENT_DESKTOP', None) desktop_session = env.get('DESKTOP_SESSION', None) if xdg_current_desktop is not\",\n \"{browser_name}{failed_message}') counts = decryptor.cookie_counts.copy() counts['unencrypted'] = unencrypted_cookies logger.debug(f'cookie version breakdown: {counts}') return jar\",\n \"page of size {len(data)} has no cookies') return p.skip_to(record_offsets[0], 'unknown page header field')\",\n \"sys.platform == 'darwin': return os.path.expanduser('~/Library/Application Support/Firefox') else: raise ValueError(f'unsupported platform: {sys.platform}') def _get_chromium_based_browser_settings(browser_name):\",\n \"= f' ({failed_cookies} could not be decrypted)' else: failed_message = '' logger.info(f'Extracted {len(jar)}\",\n \"assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger): logger.debug('using find-generic-password to obtain password\",\n \"package for your distribution') return b'' network_wallet = _get_kwallet_network_wallet(logger) try: proc = Popen([\",\n \"the following function: https://api.kde.org/frameworks/kwallet/html/classKWallet_1_1Wallet.html Wallet::NetworkWallet \\\"\\\"\\\" default_wallet = 'kdewallet' try: proc = Popen([\",\n \"logger.debug(f'cookie version breakdown: {counts}') return jar finally: if cursor is not None: cursor.connection.close()\",\n \"printer.print = lambda message: printer.print_at_line(f'[Cookies] {message}', 0) return printer def _create_progress_bar(logger): if hasattr(logger,\",\n \"used one i, paths = 0, [] with _create_progress_bar(logger) as progress_bar: for curr_root,\",\n \"as v10 (so no keyring password is required) return None assert False, f'Unknown\",\n \"# Linux keyring names can be determined by snooping on dbus while opening\",\n \"f'as the `secretstorage` module could not be initialized. {_err}' CHROMIUM_BASED_BROWSERS = {'brave', 'chrome',\",\n \"jar=None, logger=YDLLogger()): \\\"\\\"\\\" References: - https://github.com/libyal/dtformats/blob/main/documentation/Safari%20Cookies.asciidoc - this data appears to be out\",\n \"if self._ydl: self._ydl.write_debug(message) def info(self, message): if self._ydl: self._ydl.to_screen(f'[Cookies] {message}') def warning(self, message,\",\n \"from KWallet. kwallet-query should be' 'included in the kwallet package for your distribution')\",\n \"password is required) return None assert False, f'Unknown keyring {keyring}' def _get_mac_keyring_password(browser_keyring_name, logger):\",\n \"cookie: failed_cookies += 1 continue elif not is_encrypted: unencrypted_cookies += 1 jar.set_cookie(cookie) if\"\n]","isConversational":false}}},{"rowIdx":269,"cells":{"ngram":{"kind":"list like","value":["managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd():","managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.')","hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir):","<reponame>jaraco/hgtools import os import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version()","import os import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except","return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>')","mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added","baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with open(filename, 'a'):","mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz')","git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar')","managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w')","def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m',","pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr =","baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager()","mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed')","_ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir","hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed')","'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd):","mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content')","from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def","= managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add',","'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd","def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield","'.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content')","tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init',","_ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit',","yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz')","with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture","'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as","mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz:","'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with","_ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as","baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr =","'-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return","os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci',","try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture","@pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci',","@pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager()","tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar')","mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content')","'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd","Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr","'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with","'.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added","touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m',","os import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception:","os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content')","= managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz',","'-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init')","pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture","import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with","touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit',","mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am',","mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w')","open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def","open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename):","'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config',","'<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz',","'-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return","def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools')","content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email',","mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m',","tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove')","'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz:","@pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name',","as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with open(filename,","baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with open(filename, 'a'): pass","mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with","import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip()","mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def","with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.')","except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd):","tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config',","def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr)","with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def","as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr","mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr)"],"string":"[\n \"managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd():\",\n \"managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.')\",\n \"hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir):\",\n \"<reponame>jaraco/hgtools import os import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version()\",\n \"import os import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except\",\n \"return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>')\",\n \"mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added\",\n \"baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with open(filename, 'a'):\",\n \"mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz')\",\n \"git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar')\",\n \"managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w')\",\n \"def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m',\",\n \"pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr =\",\n \"baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager()\",\n \"mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed')\",\n \"_ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir\",\n \"hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed')\",\n \"'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd):\",\n \"mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content')\",\n \"from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def\",\n \"= managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add',\",\n \"'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd\",\n \"def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield\",\n \"'.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content')\",\n \"tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init',\",\n \"_ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit',\",\n \"yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz')\",\n \"with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture\",\n \"'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as\",\n \"mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz:\",\n \"'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with\",\n \"_ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as\",\n \"baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr =\",\n \"'-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return\",\n \"os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci',\",\n \"try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture\",\n \"@pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci',\",\n \"@pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager()\",\n \"tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar')\",\n \"mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content')\",\n \"'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd\",\n \"Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr\",\n \"'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with\",\n \"'.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added\",\n \"touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m',\",\n \"os import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception:\",\n \"os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content')\",\n \"= managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with open('bar/baz',\",\n \"'-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init')\",\n \"pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture\",\n \"import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with\",\n \"touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit',\",\n \"mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am',\",\n \"mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w')\",\n \"open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def\",\n \"open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename):\",\n \"'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config',\",\n \"'<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz',\",\n \"'-m', 'committed') with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return\",\n \"def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools')\",\n \"content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email',\",\n \"mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m',\",\n \"tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove')\",\n \"'HGTools') os.makedirs('bar') touch('bar/baz') mgr._invoke('add', '.') mgr._invoke('commit', '-m', 'committed') with open('bar/baz', 'w') as baz:\",\n \"@pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name',\",\n \"as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with open(filename,\",\n \"baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def touch(filename): with open(filename, 'a'): pass\",\n \"mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.') os.makedirs('bar') touch('bar/baz') mgr._invoke('addremove') mgr._invoke('ci', '-m', 'committed') with\",\n \"import pytest from hgtools import managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip()\",\n \"mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def\",\n \"with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr) mgr._invoke('init', '.')\",\n \"except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd):\",\n \"tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config',\",\n \"def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd(): yield tmpdir @pytest.fixture def hg_repo(tmpdir_as_cwd): mgr = managers.MercurialManager() _ensure_present(mgr)\",\n \"with open('bar/baz', 'w') as baz: baz.write('content') mgr._invoke('commit', '-am', 'added content') return tmpdir_as_cwd def\",\n \"as baz: baz.write('content') mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr\",\n \"mgr._invoke('ci', '-m', 'added content') return tmpdir_as_cwd @pytest.fixture def git_repo(tmpdir_as_cwd): mgr = managers.GitManager() _ensure_present(mgr)\"\n]","isConversational":false}}},{"rowIdx":270,"cells":{"ngram":{"kind":"list like","value":["isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def","def query(self, paramstyle=None): \"\"\" Returns the query part of the sql query. >>>","and `offset`. Uses vars to interpolate. Otherwise, each clause can be a SQLQuery.","r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT *","match.regs[3] token = sformat[tstart:tend] if token[0] in \"([\": level = level + 1","get concatenated to produce the actual query. \"\"\" __slots__ = [\"items\"] # tested","chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar +","NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\" if svars","any given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4'","pos + 1) elif sformat[pos] in \"([\": pos, level = pos + 1,","'%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery()","characters in the query # For backward compatability, ignore escaping when the query","in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor =",">>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>>","len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a","{} if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return","sqlify(obj): \"\"\" converts `obj` to its proper SQL version >>> sqlify(None) 'NULL' >>>","encoding='utf-8'): r\"\"\" Converts any given object to unicode string. >>> safeunicode('hello') u'hello' >>>","not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \"\"\"","what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit),","if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values):","(ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def","sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if","items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items)","_sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format string and returns","\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0 while 1: dollar = sformat.find(\"$\", pos)","tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values` into `tablename`. Returns current sequence ID.","each row to be inserted, each with the same set of keys. Returns","AND b = %s' \"\"\" return SQLQuery.join([k + ' = ' + sqlparam(v)","where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id","[\"value\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle ==",">>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'>","= val else: nout = reparam(val, svars) def xjoin(a, b): if a and","+ sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) ==","safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if t is unicode:","hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \"\"\"","tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return","def __radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self):","y = ' + sqlquote(3) <sql: \"WHERE x = 't' AND y =","target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return","AND y = 3\"> >>> 'WHERE x = ' + sqlquote(True) + '","USING ' + sqllist(using) if where: q += ' WHERE ' + where","%s, name = %s, created = NOW() WHERE name = %s' >>> q.values()","and b: return a + ' ' + b else: return a or","'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other):","= 'Joe'\"> \"\"\" if svars is None: svars = {} where = self._where(where,","return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst):","__add__(self, other): return self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery()","age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO foo (age, name, created) VALUES","level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend]","basestring): return lst else: return ', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2,",">>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b = %s' \"\"\"","basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented","provided, the items are appended to target instead of creating a new SQLQuery.","% ( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q =","You can pass this sort of thing as a clause in any db","not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some","self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam","text self.pos = pos def __str__(self): return \"unfinished expression in %s at char","`vars`) and setting `values`. >>> db = DB(None, {}) >>> name = 'Joseph'","row to be inserted, each with the same set of keys. Returns the","('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def","sql, val in sql_clauses if val is not None] qout = SQLQuery.join(clauses) if","db.supports_multiple_insert = True >>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\":","\"INSERT INTO %s DEFAULT VALUES\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False):","def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else:","_test=False, **values): \"\"\" Update `tables` with clause `where` (interpolated using `vars`) and setting","== \".\" and \\ pos + 1 < len(sformat) and sformat[pos + 1]","('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql,","db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \"\"\" Deletes from `table` with","SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return","grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b':","of dictioanries, one for each row to be inserted, each with the same","name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value for i in self.items if","def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>'","whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee)","def __init__(self): \"\"\"Creates a database. \"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute","match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \"([\": pos, level","\"\"\" dictionary = dictionary.copy() # eval mucks with it result = [] for","this sort of thing as a clause in any db function. Otherwise, you","= {} where = self._where(where, svars) query = ( \"UPDATE \" + sqllist(tables)","return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount","sqlquote([2, 3]) <sql: \"WHERE x = 't' AND y IN (2, 3)\"> \"\"\"","target_items.append(prefix) for i, item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item,","{}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql:","True and hash(1) == hash(True)` # we have to do this the hard","\"SELECT * FROM foo WHERE x = 'f'\"> >>> db.query(\"SELECT * FROM foo","where, svars=None, _test=False, **values): \"\"\" Update `tables` with clause `where` (interpolated using `vars`)","+ q(_keys) + ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return","value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle ==","\"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO","$name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE foo SET","return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query()","`group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause can be","`reparam`-style list to use instead of interpolating. >>> db = DB(None, {}) >>>","If `processed=True`, `vars` is a `reparam`-style list to use instead of interpolating. >>>","\"\"\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos","long)): if sql == 'WHERE': nout = 'id = ' + sqlquote(val) else:","% (tablename, ', '.join(keys))) for i, row in enumerate(values): if i != 0:","', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'>",">>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id =","nout = val else: nout = reparam(val, svars) def xjoin(a, b): if a","_values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \"INSERT INTO","items = other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other):","SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is","q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except","to be made to find # the id of the inserted row. q1,","' ' + b else: return a or b return xjoin(sql, nout) def","seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): #","name=?' \"\"\" s = [] for x in self.items: if isinstance(x, SQLParam): x","dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's","self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT * FROM","return \"INSERT INTO %s DEFAULT VALUES\" % table def multiple_insert(self, tablename, values, seqname=None,","test WHERE name=?' \"\"\" s = [] for x in self.items: if isinstance(x,","\"\"\" if svars is None: svars = {} where = self._where(where, svars) q","+ sqlquote(True) + ' AND y = ' + sqlquote(3) <sql: \"WHERE x","u'\\u1234' \"\"\" t = type(obj) if t is unicode: return obj elif t","dollar = sformat.find(\"$\", pos) if dollar < 0: break nextchar = sformat[dollar +","`sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v):","`processed=True`, `vars` is a `reparam`-style list to use instead of interpolating. >>> db","long)): where = \"id = \" + sqlparam(where) elif isinstance(where, (list, tuple)) and","setting `values`. >>> db = DB(None, {}) >>> name = 'Joseph' >>> q",">>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM","will call reparam for you. Internally, consists of `items`, which is a list","DEFAULT VALUES\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple","if _test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values):","Deletes from `table` with clauses `where` and `using`. >>> db = DB(None, {})","isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self","age = %s, name = %s, created = NOW() WHERE name = %s'","hash(1) == hash(True)` # we have to do this the hard way... if","other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items","db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO foo (age, name,","sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b = %s' \"\"\" return","b'> Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ',","\"\"\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql:","pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token","\"(\" + x + \")\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values","paramstyle in ['format', 'pyformat']: if '%' in x and '%%' not in x:","where = reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None, order=None,","append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other] elif","vars to interpolate. Otherwise, each clause can be a SQLQuery. >>> db =","'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ')","nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout =","class SQLLiteral: \"\"\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>>","clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\"","i, item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items)","self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where,","Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses","target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if i != 0:","= 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \"DELETE FROM foo","for use in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b'","else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try:","IN $s\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \"\"\" dictionary = dictionary.copy()","DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo', where='name = $name',","dictionary. Returns an `SQLQuery` for the result. >>> reparam(\"s = $s\", dict(s=True)) <sql:","= 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id","k in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor","itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object to unicode","= range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return","+ q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \"INSERT","name='joe'\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \"\"\"","obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def","' AND y IN ' + sqlquote([2, 3]) <sql: \"WHERE x = 't'","self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None):","the id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor,","id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2)","return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return","hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'):","paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle","and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else:","( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT","+ 1) elif sformat[pos] in \"([\": pos, level = pos + 1, 1","= text self.pos = pos def __str__(self): return \"unfinished expression in %s at","make sure all rows have same keys. for v in values: if v.keys()","') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query()","self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out","for the result. >>> reparam(\"s = $s\", dict(s=True)) <sql: \"s = 't'\"> >>>","sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'>","in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item)","'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return","'<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects a string from `sqlquote`. >>>","', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query =","sqllist(tables) + \" SET \" + sqlwhere(values, ', ') + \" WHERE \"","dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes a string and a dictionary and","or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from tokenize import tokenprog","where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars)","clauses `where` and `using`. >>> db = DB(None, {}) >>> name = 'Joe'","clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id =","BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val,","if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts the","`SQLQuery` for the result. >>> reparam(\"s = $s\", dict(s=True)) <sql: \"s = 't'\">","in a SQL query. >>> 'WHERE x = ' + sqlquote(True) + '","'s IN (1, 2)'> \"\"\" dictionary = dictionary.copy() # eval mucks with it","return sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT VALUES\" % table","', ') + \" WHERE \" + where) if _test: return query db_cursor","seqname is False: return None else: return out keys = values[0].keys() #@@ make","nout = reparam(val, svars) def xjoin(a, b): if a and b: return a","is a list of strings and SQLParams, which get concatenated to produce the","creating a new SQLQuery. \"\"\" if target is None: target = SQLQuery() target_items","in \"([\": pos, level = pos + 1, 1 while level: match, pos","( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order),","token = sformat[tstart:tend] if token[0] in \"([\": level = level + 1 elif","elif paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle,","= 2, name = 'bob', created = NOW() WHERE name = 'Joseph'\"> >>>","1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar","= {} where = self._where(where, svars) q = 'DELETE FROM ' + table","if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '):","\"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person (name, email) VALUES ('foo',","sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ',","and returns a list of 2-tuples of the form (boolean, string) where boolean","this the hard way... if obj is None: return 'NULL' elif obj is","def _interpolate(sformat): \"\"\" Takes a format string and returns a list of 2-tuples","elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items = [items] elif","class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\" pass def query(self, sql_query,processed=False,","arguments for use in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a,","interpolate it. If `processed=True`, `vars` is a `reparam`-style list to use instead of","a or b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int,","name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \"\"\" def q(x):","+ sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes",">>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if t is unicode: return obj","string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def","db.query(\"SELECT * FROM foo WHERE x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT *","xjoin(a, b): if a and b: return a + ' ' + b","'numeric': return ':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']: return","if there isn't one. >>> db = DB(None, {}) >>> q = db.insert('foo',","pass this sort of thing as a clause in any db function. Otherwise,","[other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items +","name = 'Joe'\"> \"\"\" if svars is None: svars = {} where =","keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor = self._db_cursor()","isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items else: return","or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return","are appended to target instead of creating a new SQLQuery. \"\"\" if target","if svars is None: svars = {} if not processed and not isinstance(sql_query,","for some databases, a separate query has to be made to find #","string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\"","created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE foo SET age = 2, name","<sql: \"SELECT * FROM foo WHERE x = 'f'\"> \"\"\" if svars is","1])) pos = dollar + 1 + (nextchar == \"$\") if pos <","_ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos def","$s\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \"\"\" dictionary = dictionary.copy() #","and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return","result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles (currently","string) where boolean says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py>","\"\"\" You can pass this sort of thing as a clause in any","+= ' USING ' + sqllist(using) if where: q += ' WHERE '","<sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=',","can pass a dictionary to the keyword argument `vars` and the function will","q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1,","SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT VALUES\" %","t is unicode: return obj elif t is str: return obj.decode(encoding) elif t","FROM foo WHERE x = \" + sqlquote('f'), _test=True) <sql: \"SELECT * FROM","If target argument is provided, the items are appended to target instead of","name = 'bob', created = NOW() WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE","utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\"","return ', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2,","return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format string and","NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items =","isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape","b)'> If target argument is provided, the items are appended to target instead","= dollar + 1 + (nextchar == \"$\") if pos < len(sformat): chunks.append((0,","v in values.values()], ', ') sql_query = \"INSERT INTO %s \" % tablename","= self._where(where, svars) query = ( \"UPDATE \" + sqllist(tables) + \" SET","given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>>","return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects","has to be made to find # the id of the inserted row.","= self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table,","self.items = list(items.items) else: self.items = [items] # Take care of SQLLiterals for","multiple rows into `tablename`. The `values` must be a list of dictioanries, one",">>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" # because `1","'f'\"> \"\"\" if svars is None: svars = {} if not processed and","isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj)","pos + 1 < len(sformat) and sformat[pos + 1] in namechars: match, pos","clause can be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True)","return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values` into","t = type(obj) if t is unicode: return obj elif t is str:","%s at char %d\" % ( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in",">>> 'WHERE x = ' + sqlquote(True) + ' AND y = '",">>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'),","string and a dictionary and interpolates the string using values from the dictionary.","of the inserted rows. Set `seqname` to the ID if it's not the","isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] # Take care of","== \"$\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping='","* FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE","[1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is None: self.items = []","tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what` from","'%%') s.append(x) return \"\".join(s) def values(self): \"\"\" Returns the values of the parameters","self.text = text self.pos = pos def __str__(self): return \"unfinished expression in %s",">>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix arguments","isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id = ' +","val is not None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout,","sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out =","sql_clauses(self, what, tables, where, group, order, limit, offset): return ( ('SELECT', what), ('FROM',","sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v): self.v =","used in the sql query. >>> q = SQLQuery([\"SELECT * FROM test WHERE","(list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery):","_interpolate(sformat): \"\"\" Takes a format string and returns a list of 2-tuples of","SQLQuery. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q","inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query)","_test=True) >>> q <sql: \"INSERT INTO foo (age, name, created) VALUES (2, 'bob',","= matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token ==","a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc')","FROM foo WHERE x = 'f'\"> \"\"\" if svars is None: svars =","where, group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where),","return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items","else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts","if items is None: self.items = [] elif isinstance(items, list): self.items = items","('bar', '<EMAIL>')\"> \"\"\" if not values: return [] if not self.supports_multiple_insert: out =","sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename,","else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object to utf-8","svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order,","'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided,","<sql: '(a, b)'> If target argument is provided, the items are appended to","return sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query,","* FROM foo WHERE x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM","= SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \"INSERT INTO %s","_test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\"> \"\"\" if svars","where: q += ' WHERE ' + where return q sqlproducer = SQLProducer()","s.append(x) return \"\".join(s) def values(self): \"\"\" Returns the values of the parameters used","target instead of creating a new SQLQuery. \"\"\" if target is None: target","target_items = target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if i",">>> db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name =","do this the hard way... if obj is None: return 'NULL' elif obj","use in a SQL query. >>> 'WHERE x = ' + sqlquote(True) +","sure all rows have same keys. for v in values: if v.keys() !=","2, 3]) <sql: '(1, 2, 3)'> \"\"\" items = [] items.append('(') for i,","\" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where =","= 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b =","x + \")\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v)",">>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj, unicode):","is None: svars = {} where = self._where(where, svars) q = 'DELETE FROM","'DELETE FROM ' + table if using: q += ' USING ' +","the actual query. \"\"\" __slots__ = [\"items\"] # tested in sqlquote's docstring def","db.query(\"SELECT * FROM foo WHERE x = \" + sqlquote('f'), _test=True) <sql: \"SELECT","= SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql:","out = None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where,","+ self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery):","[] items.append('(') for i, v in enumerate(values): if i != 0: items.append(', ')","created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO foo (age, name, created) VALUES (2,","1 elif token == \"}\": level = level - 1 chunks.append((1, sformat[dollar +","(int, long)): where = \"id = \" + sqlparam(where) elif isinstance(where, (list, tuple))","'WHERE x = ' + sqlquote(True) + ' AND y IN ' +","type(obj) if t is unicode: return obj elif t is str: return obj.decode(encoding)","(currently supported: qmark, numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self, text,","`a` is quoted properly for use in a SQL query. >>> 'WHERE x","LIMIT 5'> \"\"\" if svars is None: svars = {} sql_clauses = self.sql_clauses(what,","SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\" pass def query(self, sql_query,processed=False, svars=None):","else: return out keys = values[0].keys() #@@ make sure all keys are valid","return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \"\"\" converts `obj` to its","repr(obj) def sqllist(lst): \"\"\" Converts the arguments for use in something like a","FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM","form (boolean, string) where boolean says whether string should be evaled or not.","\"$\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND","@author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts","= x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters in","in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos","foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \"\"\"","True >>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>>","default, or to `False` if there isn't one. >>> db = DB(None, {})","1 + (nextchar == \"$\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks","= db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO foo (age,","db_cursor = self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname)","= %s, created = NOW() WHERE name = %s' >>> q.values() [2, 'bob',","q = 'DELETE FROM ' + table if using: q += ' USING","name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT","self._where(where, svars) q = 'DELETE FROM ' + table if using: q +=","match = tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return match,","other): return self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery() def","3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id","# automatically escape % characters in the query # For backward compatability, ignore","* FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\" if svars","a list of dictioanries, one for each row to be inserted, each with","'pyformat']: if '%' in x and '%%' not in x: x = x.replace('%',","= safestr(x) # automatically escape % characters in the query # For backward","INTO %s DEFAULT VALUES\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\"","UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other","queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix","keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES '",">>> name = 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2,","not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if","class UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles (currently supported: qmark, numeric, format,","argument is provided, the items are appended to target instead of creating a","Update `tables` with clause `where` (interpolated using `vars`) and setting `values`. >>> db","not the default, or to `False` if there isn't one. >>> db =","* FROM test WHERE name=?' \"\"\" s = [] for x in self.items:","from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to","None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False,","svars) def xjoin(a, b): if a and b: return a + ' '","on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'):","elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1)","and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other):","NOW() WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE foo SET age = %s,","thing as a clause in any db function. Otherwise, you can pass a","= level + 1 elif token[0] in \")]\": level = level - 1","SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles (currently supported: qmark,","token[0] in \")]\": level = level - 1 else: break chunks.append((1, sformat[dollar +","sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT VALUES\" % table def","+ 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos =","x = x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self): \"\"\" Returns the values","+ 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 +","2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\"","function. Otherwise, you can pass a dictionary to the keyword argument `vars` and","foo\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT * FROM foo WHERE","x = safestr(x) # automatically escape % characters in the query # For","limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if","token == \"}\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos -","SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape %","SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where","INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values:",">>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe']","in namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \"([\":","return \"'t'\" elif obj is False: return \"'f'\" elif datetime and isinstance(obj, datetime.datetime):","_test=False, **values): \"\"\" Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname`","__iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return","pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \"([\": level","= 0 while 1: dollar = sformat.find(\"$\", pos) if dollar < 0: break","isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility","of ids of the inserted rows. Set `seqname` to the ID if it's","isn't one. >>> db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2,","\"\"\" def q(x): return \"(\" + x + \")\" if values: _keys =","any db function. Otherwise, you can pass a dictionary to the keyword argument","foo WHERE name = 'Joe'\"> \"\"\" if svars is None: svars = {}","is unicode: return obj elif t is str: return obj.decode(encoding) elif t in","xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)): where = \"id","\" + where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if","!= 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return","self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None,","svars): if isinstance(where, (int, long)): where = \"id = \" + sqlparam(where) elif","chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a `dictionary` to an SQL","and '%%' not in x: x = x.replace('%', '%%') s.append(x) return \"\".join(s) def","there isn't one. >>> db = DB(None, {}) >>> q = db.insert('foo', name='bob',","isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values","range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out","'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring):","in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes a string and a dictionary","__add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items =","5'> \"\"\" if svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables,","= [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] #","a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\"","\", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor = self._db_cursor() if seqname","level + 1 elif token[0] in \")]\": level = level - 1 else:","\"\"\" __slots__ = [\"items\"] # tested in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates","- 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar","{}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id","a clause in any db function. Otherwise, you can pass a dictionary to","datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def","AND y IN ' + sqlquote([2, 3]) <sql: \"WHERE x = 't' AND","as a clause in any db function. Otherwise, you can pass a dictionary","group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in","def sqllist(lst): \"\"\" Converts the arguments for use in something like a WHERE","clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val is","def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self):","target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item in","isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where def select(self, tables,","+ 1) while pos < len(sformat): if sformat[pos] == \".\" and \\ pos","<sql: \"s = 't'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's IN","def sqlify(obj): \"\"\" converts `obj` to its proper SQL version >>> sqlify(None) 'NULL'","pos < len(sformat): if sformat[pos] == \".\" and \\ pos + 1 <","\\ pos + 1 < len(sformat) and sformat[pos + 1] in namechars: match,","class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos","safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects a","# For backward compatability, ignore escaping when the query looks already escaped if","SQLLiteral: \"\"\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()'))","isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items + items) def","group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP","`what` from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars","return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY',","multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and","('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql","SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" #","keys = values[0].keys() #@@ make sure all keys are valid # make sure","'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2,","isinstance(where, (int, long)): where = \"id = \" + sqlparam(where) elif isinstance(where, (list,","you can pass a dictionary to the keyword argument `vars` and the function","_test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \"\"\"","DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True)","Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")])","in ['format', 'pyformat']: if '%' in x and '%%' not in x: x","self.v = v def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates","SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items =","s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters in the query","[] for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else:","obj is True: return \"'t'\" elif obj is False: return \"'f'\" elif datetime","for i, item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery):","the result. >>> reparam(\"s = $s\", dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s","def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql == 'WHERE':","return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)): where =","FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT *","elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] # Take care","_keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ',","group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what` from `tables` with clauses `where`, `order`,","'WHERE': nout = 'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif","_sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \"\"\" items = [] items.append('(') for","not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables,","\"\"\" return [i.value for i in self.items if isinstance(i, SQLParam)] def join(items, sep='","and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos + 1)","list of 2-tuples of the form (boolean, string) where boolean says whether string","boolean says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain,","+ 1] in namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos]","DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"},","out = range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit()","target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor = self._db_cursor() if seqname is","in values.values()], ', ') sql_query = \"INSERT INTO %s \" % tablename +","pass a dictionary to the keyword argument `vars` and the function will call","3\"> >>> 'WHERE x = ' + sqlquote(True) + ' AND y IN","test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>>","def sql_clauses(self, what, tables, where, group, order, limit, offset): return ( ('SELECT', what),","table): return \"INSERT INTO %s DEFAULT VALUES\" % table def multiple_insert(self, tablename, values,","foo SET age = %s, name = %s, created = NOW() WHERE name","x: x = x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self): \"\"\" Returns the","for sql, val in sql_clauses if val is not None] qout = SQLQuery.join(clauses)",">>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \"\"\" dictionary","__init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q =","elif sformat[pos] in \"([\": pos, level = pos + 1, 1 while level:","\"([\": level = level + 1 elif token[0] in \")]\": level = level","get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return","'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE","SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i]","= v def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a","one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values =","a format string and returns a list of 2-tuples of the form (boolean,","not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from tokenize import tokenprog tokenprog","2, 3)'> \"\"\" items = [] items.append('(') for i, v in enumerate(values): if","name=%s' >>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self, value): self.value =","tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match","% repr(str(self)) class SQLLiteral: \"\"\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql:","\"UPDATE foo SET age = 2, name = 'bob', created = NOW() WHERE","= %s AND b = %s' \"\"\" return SQLQuery.join([k + ' = '","qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values`","1 while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token","cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3,","items is None: self.items = [] elif isinstance(items, list): self.items = items elif","must be a list of dictioanries, one for each row to be inserted,","encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if","test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value for i in","') sql_query = \"INSERT INTO %s \" % tablename + q(_keys) + '","isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items + self.items) def","') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is quoted properly","__init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return","else: where = reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None,","sqllist(using) if where: q += ' WHERE ' + where return q sqlproducer","value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other,","= matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in","live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk)","\"\"\"Creates a database. \"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query","= self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars)","argument `vars` and the function will call reparam for you. Internally, consists of","foo WHERE x = 'f'\"> >>> db.query(\"SELECT * FROM foo WHERE x =","the form (boolean, string) where boolean says whether string should be evaled or","b): if a and b: return a + ' ' + b else:","offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql ==","q(x): return \"(\" + x + \")\" if values: _keys = SQLQuery.join(values.keys(), ',","values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO","= %s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\" if svars is None: svars","level = level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0,","db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self,","tend = match.regs[3] token = sformat[tstart:tend] if token == \"{\": level = level","out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out def","return '<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects a string from `sqlquote`.","nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while","tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is","('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if","b = %s' \"\"\" return SQLQuery.join([k + ' = ' + sqlparam(v) for","('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values: return [] if not self.supports_multiple_insert:","the list of ids of the inserted rows. Set `seqname` to the ID","self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring):","where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\"","some databases, a separate query has to be made to find # the","'a', 'b': 'b'}).query() 'a = %s AND b = %s' \"\"\" return SQLQuery.join([k","enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value):","age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE foo SET age =","return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self))","of thing as a clause in any db function. Otherwise, you can pass","one for each row to be inserted, each with the same set of","v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\"","elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars) def xjoin(a,","set of keys. Returns the list of ids of the inserted rows. Set","q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q","{} where = self._where(where, svars) query = ( \"UPDATE \" + sqllist(tables) +","None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self):","return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts","= [items] # Take care of SQLLiterals for i, item in enumerate(self.items): if","return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return","len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout","= SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout","is None: return 'NULL' elif obj is True: return \"'t'\" elif obj is","* FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?'","name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM test WHERE name='joe'\"> >>> q.query()","['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self,","def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query` using dictionary `vars` to","+ sqlquote([2, 3]) <sql: \"WHERE x = 't' AND y IN (2, 3)\">","return a or b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where,","sqlwhere(values, ', ') + \" WHERE \" + where) if _test: return query","v in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes a string and a","nout = 'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val,","\"\"\" if svars is None: svars = {} where = self._where(where, svars) query","'a = %s AND b = %s' \"\"\" return SQLQuery.join([k + ' =","of interpolating. >>> db = DB(None, {}) >>> db.query(\"SELECT * FROM foo\", _test=True)","= bar.id LIMIT 5'> \"\"\" if svars is None: svars = {} sql_clauses","Set `seqname` to the ID if it's not the default, or to `False`","self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) #","be made to find # the id of the inserted row. q1, q2","%s, created = NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph']","\"'f'\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj","else: return NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\"","and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')')","'Joseph'\"> >>> q.query() 'UPDATE foo SET age = %s, name = %s, created","# tested in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>>","level = level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar","if where: q += ' WHERE ' + where return q sqlproducer =",">>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is None: self.items = [] elif","= 'bob', created = NOW() WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE foo","values, seqname=None, _test=False): \"\"\" Inserts multiple rows into `tablename`. The `values` must be","pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0]","sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset))","None: self.items = [] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam):","in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\"","= [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val is not",">>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v): self.v = v def __repr__(self):","new SQLQuery. \"\"\" if target is None: target = SQLQuery() target_items = target.items","and interpolates the string using values from the dictionary. Returns an `SQLQuery` for","\"\"\" if svars is None: svars = {} if not processed and not","\"\"\" Takes a string and a dictionary and interpolates the string using values","+ ' AND y IN ' + sqlquote([2, 3]) <sql: \"WHERE x =","sformat[pos] == \".\" and \\ pos + 1 < len(sformat) and sformat[pos +","Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix",">>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql:","vars=locals(), _test=True) >>> q <sql: \"UPDATE foo SET age = 2, name =","def __add__(self, other): return self.sqlquery() + other def __radd__(self, other): return other +","chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while level: match, pos","(age, name, created) VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO foo (age,","(name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values: return []","\"INSERT INTO %s \" % tablename + q(_keys) + ' VALUES ' +","iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \"\"\" converts `obj` to","isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries.","= bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id =","dictionary and interpolates the string using values from the dictionary. Returns an `SQLQuery`","= 'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list,","[] for live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v))","', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test","elif paramstyle == 'numeric': return ':1' elif paramstyle is None or paramstyle in","return self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery() def __str__(self):","svars=None): \"\"\" Execute SQL query `sql_query` using dictionary `vars` to interpolate it. If","in \"([\": level = level + 1 elif token[0] in \")]\": level =","def update(self, tables, where, svars=None, _test=False, **values): \"\"\" Update `tables` with clause `where`","= ( \"UPDATE \" + sqllist(tables) + \" SET \" + sqlwhere(values, ',","SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self, other): return other","to `False` if there isn't one. >>> db = DB(None, {}) >>> q","item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def","sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a","\"\"\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match =","__str__(self): return \"unfinished expression in %s at char %d\" % ( repr(self.text), self.pos)","i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures","return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\" pass def","= \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0 while 1: dollar","reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None,",">>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return lst else: return ', '.join(lst)","SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT","else: x = safestr(x) # automatically escape % characters in the query #","(www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given","seqname=seqname, _test=_test, **v) for v in values] if seqname is False: return None","return str(obj) def sqlify(obj): \"\"\" converts `obj` to its proper SQL version >>>","Take care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and","class SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT * FROM test","3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND","_where(self, where, svars): if isinstance(where, (int, long)): where = \"id = \" +","+ ' AND y = ' + sqlquote(3) <sql: \"WHERE x = 't'","2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val","'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE","items = [other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return","the items are appended to target instead of creating a new SQLQuery. \"\"\"","'3' \"\"\" # because `1 == True and hash(1) == hash(True)` # we","repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT *","= values[0].keys() #@@ make sure all keys are valid # make sure all","v in values] if seqname is False: return None else: return out keys","if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix:","in enumerate(values): if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys],","elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query())","`seqname` to the ID if it's not the default, or to `False` if","values] if seqname is False: return None else: return out keys = values[0].keys()","`order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause can","if svars is None: svars = {} where = self._where(where, svars) query =","evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from tokenize import","\"}\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif","level = pos + 1, 1 while level: match, pos = matchorfail(sformat, pos)","Converts any given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2'","= SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0],","tablename + q(_keys) + ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename))","if isinstance(where, (int, long)): where = \"id = \" + sqlparam(where) elif isinstance(where,","__radd__(self, other): if isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items","if sql == 'WHERE': nout = 'id = ' + sqlquote(val) else: nout","of the parameters used in the sql query. >>> q = SQLQuery([\"SELECT *","VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table):","'Joe'\"> \"\"\" if svars is None: svars = {} where = self._where(where, svars)","\" + sqllist(tables) + \" SET \" + sqlwhere(values, ', ') + \"","= 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'),","y IN (2, 3)\"> \"\"\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery()","%s AND b = %s' \"\"\" return SQLQuery.join([k + ' = ' +","SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value for i in self.items if isinstance(i,","' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self,","val else: nout = reparam(val, svars) def xjoin(a, b): if a and b:","result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for unsupported db","' + sqlquote(3) <sql: \"WHERE x = 't' AND y = 3\"> >>>","def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple rows into `tablename`. The","pos) if dollar < 0: break nextchar = sformat[dollar + 1] if nextchar","('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT',","val, svars) for sql, val in sql_clauses if val is not None] qout","2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where,","pass else: where = reparam(where, svars) return where def select(self, tables, svars=None, what='*',","+ 2, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend =","' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return","if prefix: target_items.append(prefix) for i, item in enumerate(items): if i != 0: target_items.append(sep)","def __str__(self): return \"unfinished expression in %s at char %d\" % ( repr(self.text),","Returns the values of the parameters used in the sql query. >>> q","offset=None, _test=False): \"\"\" Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`,","\"\"\" Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname` to the","order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int,","db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar',","level = dollar + 2, 1 while level: match, pos = matchorfail(sformat, pos)","SQLParam class SQLQuery(object): \"\"\" You can pass this sort of thing as a","[self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val is not None]",">>> reparam(\"s = $s\", dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s IN $s\",","self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items)","what, tables, where, group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)),","valid # make sure all rows have same keys. for v in values:","\"\"\" Converts the arguments for use in something like a WHERE clause. >>>","limit=None, offset=None, _test=False): \"\"\" Selects `what` from `tables` with clauses `where`, `order`, `group`,","is not None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True)","elif obj is True: return \"'t'\" elif obj is False: return \"'f'\" elif","token == \"{\": level = level + 1 elif token == \"}\": level","val in sql_clauses if val is not None] qout = SQLQuery.join(clauses) if _test:","= value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle","chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos < len(sformat):","* FROM test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE","AND '): \"\"\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>>","tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return match, match.end() namechars","Internally, consists of `items`, which is a list of strings and SQLParams, which","or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts","sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group, order,","self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \"\"\" Deletes","1) while pos < len(sformat): if sformat[pos] == \".\" and \\ pos +","def insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values` into `tablename`. Returns current","' + sqllist(using) if where: q += ' WHERE ' + where return","limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT","keyword argument `vars` and the function will call reparam for you. Internally, consists","tested in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\")","and hash(1) == hash(True)` # we have to do this the hard way...","query = ( \"UPDATE \" + sqllist(tables) + \" SET \" + sqlwhere(values,","!= 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a`","each with the same set of keys. Returns the list of ids of","== hash(True)` # we have to do this the hard way... if obj","* FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM test","len(sformat): if sformat[pos] == \".\" and \\ pos + 1 < len(sformat) and","if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple):","= ' + sqlquote(3) <sql: \"WHERE x = 't' AND y = 3\">","else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar ==","SQLParams, which get concatenated to produce the actual query. \"\"\" __slots__ = [\"items\"]","is str: return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif","from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text,","SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \"INSERT INTO %s \"","dict(s=[1, 2])) <sql: 's IN (1, 2)'> \"\"\" dictionary = dictionary.copy() # eval","\"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person (name, email)","unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given","'b': 'b'}).query() 'a = %s AND b = %s' \"\"\" return SQLQuery.join([k +","dollar + 1 + (nextchar == \"$\") if pos < len(sformat): chunks.append((0, sformat[pos:]))","the query part of the sql query. >>> q = SQLQuery([\"SELECT * FROM","= DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo',","created = NOW() WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE foo SET age","\"WHERE x = 't' AND y IN (2, 3)\"> \"\"\" if isinstance(a, list):","= [other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items","3]) <sql: \"WHERE x = 't' AND y IN (2, 3)\"> \"\"\" if","elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj =","\"unfinished expression in %s at char %d\" % ( repr(self.text), self.pos) class SQLParam(object):","', ') <sql: 'a, b'> Optinally, prefix and suffix arguments can be provided.","= True >>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}]","level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar +","+ sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0],","'__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\"","in x and '%%' not in x: x = x.replace('%', '%%') s.append(x) return","where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE","def __init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q","FROM foo WHERE x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo","(list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif","q <sql: \"SELECT * FROM test WHERE name='joe'\"> >>> q.query() 'SELECT * FROM","u'abc' \"\"\" if isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values):","SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout =","safestr(x) # automatically escape % characters in the query # For backward compatability,","return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return","sqlquote(True) + ' AND y = ' + sqlquote(3) <sql: \"WHERE x =","repr(str(self)) class SQLLiteral: \"\"\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\">","i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \", target=sql_query,","NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other)","str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return","each clause can be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo',","sequence ID. Set `seqname` to the ID if it's not the default, or","\"\"\" Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\",","# because `1 == True and hash(1) == hash(True)` # we have to","of `items`, which is a list of strings and SQLParams, which get concatenated",">>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if","\"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj,","+ b else: return a or b return xjoin(sql, nout) def _where(self, where,","arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a,","prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql:","= 'f'\"> \"\"\" if svars is None: svars = {} if not processed","\"SELECT * FROM foo WHERE x = 'f'\"> \"\"\" if svars is None:","sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor = self._db_cursor() if","+ items) def __radd__(self, other): if isinstance(other, basestring): items = [other] else: return","foo WHERE x = \" + sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo","x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters in the","def xjoin(a, b): if a and b: return a + ' ' +","2-tuples of the form (boolean, string) where boolean says whether string should be","\"\"\" Inserts multiple rows into `tablename`. The `values` must be a list of","UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat)","', ') sql_query = \"INSERT INTO %s \" % tablename + q(_keys) +","_interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '')","val, svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id","+ 1 + (nextchar == \"$\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return","seqname) if isinstance(sql_query, tuple): # for some databases, a separate query has to","target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x)","self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif","unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t","paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self])","age = 2, name = 'bob', created = NOW() WHERE name = 'Joseph'\">","sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for","in %s at char %d\" % ( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter","<sql: \"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if","using=None, svars=None, _test=False): \"\"\" Deletes from `table` with clauses `where` and `using`. >>>","SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM",">>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO",">>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT","what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what` from `tables` with","+ \" WHERE \" + where) if _test: return query db_cursor = self._db_cursor()","part of the sql query. >>> q = SQLQuery([\"SELECT * FROM test WHERE","'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3},","of creating a new SQLQuery. \"\"\" if target is None: target = SQLQuery()","if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit()","') <sql: 'a, b'> Optinally, prefix and suffix arguments can be provided. >>>","query. \"\"\" __slots__ = [\"items\"] # tested in sqlquote's docstring def __init__(self, items=None):","\"\"\" if not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname,","\"WHERE x = 't' AND y = 3\"> >>> 'WHERE x = '","table if using: q += ' USING ' + sqllist(using) if where: q","1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos","SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False,","<sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v): self.v = v","self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return","q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out","the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor,","and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery):","= SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None,","1) elif sformat[pos] in \"([\": pos, level = pos + 1, 1 while","pos, level = pos + 1, 1 while level: match, pos = matchorfail(sformat,","to produce the actual query. \"\"\" __slots__ = [\"items\"] # tested in sqlquote's","_test=False): \"\"\" Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`, and","SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value","if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query","svars=None, _test=False, **values): \"\"\" Update `tables` with clause `where` (interpolated using `vars`) and","\" + sqlwhere(values, ', ') + \" WHERE \" + where) if _test:","elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items + items)","db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE name =","else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO %s","db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\"name\": \"foo\",","INTO foo (age, name, created) VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO","have to do this the hard way... if obj is None: return 'NULL'","automatically escape % characters in the query # For backward compatability, ignore escaping","+ 1])) pos = dollar + 1 + (nextchar == \"$\") if pos","'bob', NOW())\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s,","AND y IN (2, 3)\"> \"\"\" if isinstance(a, list): return _sqllist(a) else: return","char %d\" % ( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery. >>>","(interpolated using `vars`) and setting `values`. >>> db = DB(None, {}) >>> name","x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(),","sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT","= db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None if not","elif token == \"}\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos","encoding='utf-8'): r\"\"\" Converts any given object to utf-8 encoded string. >>> safestr('hello') 'hello'","which is a list of strings and SQLParams, which get concatenated to produce","pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token == \"{\": level","offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val","while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token =","self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins","query. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.values()","to interpolate. Otherwise, each clause can be a SQLQuery. >>> db = DB(None,","def _get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT VALUES\" % table def multiple_insert(self,","\"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT","'NULL' elif obj is True: return \"'t'\" elif obj is False: return \"'f'\"","''' Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def","it result = [] for live, chunk in _interpolate(string_): if live: v =","interpolate. Otherwise, each clause can be a SQLQuery. >>> db = DB(None, {})","SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries. >>>","'t'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \"\"\"","(%s) VALUES ' % (tablename, ', '.join(keys))) for i, row in enumerate(values): if","{}) >>> name = 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob',","self.items = [] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items","**v) for v in values] if seqname is False: return None else: return","', '.join(keys))) for i, row in enumerate(values): if i != 0: sql_query.append(\", \")","matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos)","(2, 3)\"> \"\"\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat):","< len(sformat) and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos","return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class","db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions:","unicode: return obj elif t is str: return obj.decode(encoding) elif t in [int,","_test=False): \"\"\" Inserts multiple rows into `tablename`. The `values` must be a list","Takes a format string and returns a list of 2-tuples of the form","sql_query = \"INSERT INTO %s \" % tablename + q(_keys) + ' VALUES","if obj is None: return 'NULL' elif obj is True: return \"'t'\" elif",">>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self, value): self.value = value","= obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts the arguments for use in","'t' AND y = 3\"> >>> 'WHERE x = ' + sqlquote(True) +","tables, where, group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE',","lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any","def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric':","values.values()], ', ') sql_query = \"INSERT INTO %s \" % tablename + q(_keys)","SQLQuery): self.items = list(items.items) else: self.items = [items] # Take care of SQLLiterals","to `False` if there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert","\"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person (name, email) VALUES","is True: return \"'t'\" elif obj is False: return \"'f'\" elif datetime and","_test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5,","dictionary = dictionary.copy() # eval mucks with it result = [] for live,","= [] for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x))","`where` and `using`. >>> db = DB(None, {}) >>> name = 'Joe' >>>","{}) >>> db.supports_multiple_insert = True >>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\":","0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\")","lst else: return ', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql:","= %s, name = %s, created = NOW() WHERE name = %s' >>>","'\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str):","elif isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif","to target instead of creating a new SQLQuery. \"\"\" if target is None:","Converts the arguments for use in something like a WHERE clause. >>> sqllist(['a',","backward compatability, ignore escaping when the query looks already escaped if paramstyle in","= tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return match, match.end()","def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object to unicode string. >>> safeunicode('hello')","[2, 'bob', 'Joseph'] \"\"\" if svars is None: svars = {} where =","\"'t'\" >>> sqlify(3) '3' \"\"\" # because `1 == True and hash(1) ==",">>> db.query(\"SELECT * FROM foo WHERE x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT","NOW())' >>> q.values() [2, 'bob'] \"\"\" def q(x): return \"(\" + x +","< 0: break nextchar = sformat[dollar + 1] if nextchar == \"{\": chunks.append((0,","+ sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\"> \"\"\"","query part of the sql query. >>> q = SQLQuery([\"SELECT * FROM test","dollar + 1) while pos < len(sformat): if sformat[pos] == \".\" and \\","[other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other,",">>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__","be a list of dictioanries, one for each row to be inserted, each",">>> q <sql: \"SELECT * FROM test WHERE name='joe'\"> >>> q.query() 'SELECT *","suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return self.query() %","keys are valid # make sure all rows have same keys. for v","def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam =","suffix=\")\") if _test: return sql_query db_cursor = self._db_cursor() if seqname is not False:","2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b = %s'","elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj,","x = ' + sqlquote(True) + ' AND y = ' + sqlquote(3)",">>> db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT","isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts the arguments","q.values() [2, 'bob', 'Joseph'] \"\"\" if svars is None: svars = {} where","= $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\">","`False` if there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert =","q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__ =",">>> db.supports_multiple_insert = True >>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\",","if dollar < 0: break nextchar = sformat[dollar + 1] if nextchar ==","chunks = [] pos = 0 while 1: dollar = sformat.find(\"$\", pos) if","the query # For backward compatability, ignore escaping when the query looks already","* FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items","of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else:","return [i.value for i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ',","dollar + 2, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend","INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob']","name = 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2, ...","_str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError):","' AND y = ' + sqlquote(3) <sql: \"WHERE x = 't' AND","pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\"","to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3)","not None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def","svars is None: svars = {} where = self._where(where, svars) query = (","if sformat[pos] == \".\" and \\ pos + 1 < len(sformat) and sformat[pos","%s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\" if svars is None: svars =",">>> q.query() 'UPDATE foo SET age = %s, name = %s, created =","sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos + 1) elif","target is None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for","2, name = 'bob', created = NOW() WHERE name = 'Joseph'\"> >>> q.query()",">>> q <sql: \"UPDATE foo SET age = 2, name = 'bob', created","if it's not the default, or to `False` if there isn't one. >>>","str(obj) def sqlify(obj): \"\"\" converts `obj` to its proper SQL version >>> sqlify(None)","q.values() ['joe'] \"\"\" return [i.value for i in self.items if isinstance(i, SQLParam)] def","# make sure all rows have same keys. for v in values: if","db paramstyles (currently supported: qmark, numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError): def","v def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database.","_test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'>","paramstyle == 'numeric': return ':1' elif paramstyle is None or paramstyle in ['format',","rows. Set `seqname` to the ID if it's not the default, or to","+ ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def","\"'t'\" elif obj is False: return \"'f'\" elif datetime and isinstance(obj, datetime.datetime): return","Execute SQL query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars`","[self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname is False: return",">>> q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT","name = %s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\" if svars is None:","table, where, using=None, svars=None, _test=False): \"\"\" Deletes from `table` with clauses `where` and","\")]\": level = level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else:","__repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\" pass","q.values() [2, 'bob'] \"\"\" def q(x): return \"(\" + x + \")\" if","values of the parameters used in the sql query. >>> q = SQLQuery([\"SELECT","len(sformat) and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos +","\"\"\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2,","sqlquote(3) <sql: \"WHERE x = 't' AND y = 3\"> >>> 'WHERE x","self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values): \"\"\" Update","if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join =","return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \"\"\" Deletes from `table`","+ ' = ' + sqlparam(v) for k, v in dictionary.items()], grouping) def","WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE foo SET age = %s, name","svars) query = ( \"UPDATE \" + sqllist(tables) + \" SET \" +","DB(None, {}) >>> db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT * FROM foo'>",">>> values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person',","where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what` from `tables` with clauses","sql query. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>>","`tables` with clause `where` (interpolated using `vars`) and setting `values`. >>> db =","== 'WHERE': nout = 'id = ' + sqlquote(val) else: nout = SQLQuery(val)","else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring,","limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group),","q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\"","# backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars)","q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO","db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>>","created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \"\"\" def q(x): return","' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'>","return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\" You can","try: return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return","'UPDATE foo SET age = %s, name = %s, created = NOW() WHERE","i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix)","str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object to utf-8 encoded string.","sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a `dictionary` to an SQL WHERE clause","chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return","str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object):","if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return","\"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT","reparam(val, svars) def xjoin(a, b): if a and b: return a + '","match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0 while","WHERE x = 'f'\"> \"\"\" if svars is None: svars = {} if","self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values` into `tablename`.","def __radd__(self, other): if isinstance(other, basestring): items = [other] else: return NotImplemented return","order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what` from `tables` with clauses `where`,","else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format string and returns a","domain, Ka-Ping Yee) \"\"\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text,","return \"'f'\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode):","2)'> \"\"\" dictionary = dictionary.copy() # eval mucks with it result = []","= SQLParam class SQLQuery(object): \"\"\" You can pass this sort of thing as","None: svars = {} if not processed and not isinstance(sql_query, SQLQuery): sql_query =","is None: svars = {} where = self._where(where, svars) query = ( \"UPDATE","for live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else:","'f'\"> >>> db.query(\"SELECT * FROM foo WHERE x = \" + sqlquote('f'), _test=True)","', prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ')","== 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout =","(age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \"\"\" def","from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self,","namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0 while 1:","else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring):","namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \"([\": pos,","for i, row in enumerate(values): if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for","= [] for live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary)","i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None):","interpolates the string using values from the dictionary. Returns an `SQLQuery` for the","\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not",">>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \"DELETE","SQLQuery.join([k + ' = ' + sqlparam(v) for k, v in dictionary.items()], grouping)","def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \"\"\" items","except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str())",">>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument","x = 'f'\"> \"\"\" if svars is None: svars = {} if not","return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos =","`values` must be a list of dictioanries, one for each row to be","self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \"\"\" Deletes from","= %s' \"\"\" return SQLQuery.join([k + ' = ' + sqlparam(v) for k,","{\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person (name,","3)'> \"\"\" items = [] items.append('(') for i, v in enumerate(values): if i","= [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname is False:","elif token[0] in \")]\": level = level - 1 else: break chunks.append((1, sformat[dollar","return lst else: return ', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3])","= tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None:","to the keyword argument `vars` and the function will call reparam for you.","\"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally,","to use instead of interpolating. >>> db = DB(None, {}) >>> db.query(\"SELECT *","\"{\": level = level + 1 elif token == \"}\": level = level","join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'],","using values from the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\"s","qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self, tablename,","= item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items","elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj,","items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is quoted properly for use","version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" # because","target join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x","return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object to utf-8 encoded","multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple rows into `tablename`. The `values`","def q(x): return \"(\" + x + \")\" if values: _keys = SQLQuery.join(values.keys(),","FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s',","rows have same keys. for v in values: if v.keys() != keys: raise","(nextchar == \"$\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary,","separate query has to be made to find # the id of the","bar.id LIMIT 5'> \"\"\" if svars is None: svars = {} sql_clauses =","`obj` to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>>","obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr,","# Take care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam)","+ sqllist(tables) + \" SET \" + sqlwhere(values, ', ') + \" WHERE",">>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \"\"\" items = [] items.append('(')","returns a list of 2-tuples of the form (boolean, string) where boolean says","order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY',","tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \"([\": level =","to be inserted, each with the same set of keys. Returns the list","x = 't' AND y IN (2, 3)\"> \"\"\" if isinstance(a, list): return","name = %s, created = NOW() WHERE name = %s' >>> q.values() [2,","Yee) \"\"\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match","while 1: dollar = sformat.find(\"$\", pos) if dollar < 0: break nextchar =","match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0","(1, 2)'> \"\"\" dictionary = dictionary.copy() # eval mucks with it result =","u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if t","reparam for you. Internally, consists of `items`, which is a list of strings","into `tablename`. The `values` must be a list of dictioanries, one for each","_test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT * FROM foo WHERE x","'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ',","# we have to do this the hard way... if obj is None:","in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql:","items = [other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other):","a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql:","< len(sformat): if sformat[pos] == \".\" and \\ pos + 1 < len(sformat)","== 'numeric': return ':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']:","to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id =","list): self.items = items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery):","0 while 1: dollar = sformat.find(\"$\", pos) if dollar < 0: break nextchar","', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided, the items","if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a","pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return \"unfinished expression","other): return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param:","items) def __radd__(self, other): if isinstance(other, basestring): items = [other] else: return NotImplemented","WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\" if svars is","should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from","\"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0 while 1: dollar =","clause `where` (interpolated using `vars`) and setting `values`. >>> db = DB(None, {})","== \"}\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos - 1]))","an `SQLQuery` for the result. >>> reparam(\"s = $s\", dict(s=True)) <sql: \"s =","foo SET age = 2, name = 'bob', created = NOW() WHERE name","= $s\", dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2]))","* FROM test WHERE name='joe'\"> >>> q.query() 'SELECT * FROM test WHERE name=%s'","something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a'","+ 1 elif token[0] in \")]\": level = level - 1 else: break","+ 1 < len(sformat) and sformat[pos + 1] in namechars: match, pos =","itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \"\"\" converts `obj` to its proper","return \"\".join(s) def values(self): \"\"\" Returns the values of the parameters used in","can be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql:","b: return a + ' ' + b else: return a or b","level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars:","with it result = [] for live, chunk in _interpolate(string_): if live: v","ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename,","all rows have same keys. for v in values: if v.keys() != keys:","isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else:","unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts the arguments for","looks already escaped if paramstyle in ['format', 'pyformat']: if '%' in x and","IN (2, 3)\"> \"\"\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def","pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos","for x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str())","current sequence ID. Set `seqname` to the ID if it's not the default,","WHERE name=?' \"\"\" s = [] for x in self.items: if isinstance(x, SQLParam):","self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql:","pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos =","= 'f'\"> >>> db.query(\"SELECT * FROM foo WHERE x = \" + sqlquote('f'),","FROM test WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self,","+ other def __radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value)","'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle is None","an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3","return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the query","obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts the arguments for use","in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self):","db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar","None: svars = {} where = self._where(where, svars) q = 'DELETE FROM '","_test=_test, **v) for v in values] if seqname is False: return None else:","else: self.items = [items] # Take care of SQLLiterals for i, item in","sformat[pos] in \"([\": pos, level = pos + 1, 1 while level: match,","the hard way... if obj is None: return 'NULL' elif obj is True:","inserted, each with the same set of keys. Returns the list of ids","\"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while level: match,","['format', 'pyformat']: if '%' in x and '%%' not in x: x =","safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object to unicode string. >>> safeunicode('hello') u'hello'","= None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None,","name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO foo (age, name, created)","= [] pos = 0 while 1: dollar = sformat.find(\"$\", pos) if dollar","= ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and","svars = {} where = self._where(where, svars) q = 'DELETE FROM ' +","_test=True) <sql: \"DELETE FROM foo WHERE name = 'Joe'\"> \"\"\" if svars is","bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return","sformat.find(\"$\", pos) if dollar < 0: break nextchar = sformat[dollar + 1] if","[int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj)","q += ' USING ' + sqllist(using) if where: q += ' WHERE","self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery() def __str__(self): return","q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'>","SET age = 2, name = 'bob', created = NOW() WHERE name =","'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return lst else: return ',","SQL query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars` is","%s \" % tablename + q(_keys) + ' VALUES ' + q(_values) else:","function will call reparam for you. Internally, consists of `items`, which is a","or b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)):","def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object to utf-8 encoded string. >>>","q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT *","the string using values from the dictionary. Returns an `SQLQuery` for the result.","'.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \"\"\"","chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match,","None: return 'NULL' elif obj is True: return \"'t'\" elif obj is False:","\"\"\" if isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values): \"\"\"","in the sql query. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\",","given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4')","in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def","target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self):","`tablename`. The `values` must be a list of dictioanries, one for each row","svars) q = 'DELETE FROM ' + table if using: q += '","FROM test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s'","= DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(),","= SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for i,","<http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from tokenize import tokenprog tokenprog = tokenprog","= 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql:","'SELECT * FROM test WHERE name=?' \"\"\" s = [] for x in","Returns the query part of the sql query. >>> q = SQLQuery([\"SELECT *","1 elif token[0] in \")]\": level = level - 1 else: break chunks.append((1,","db = DB(None, {}) >>> db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT *","(int, long)): if sql == 'WHERE': nout = 'id = ' + sqlquote(val)","SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is quoted properly for use in a","i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v","return \"unfinished expression in %s at char %d\" % ( repr(self.text), self.pos) class","and `using`. >>> db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo',","v in values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query =","if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value)","if not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test,","in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def","pos def __str__(self): return \"unfinished expression in %s at char %d\" % (","= \" + sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo WHERE x =","3)\"> \"\"\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\"","limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if","return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj)","at char %d\" % ( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery.","':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s' raise","if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'):","from the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\"s = $s\",","SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1])","bar WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\" if svars is None: svars","in the query # For backward compatability, ignore escaping when the query looks","+ x + \")\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values =","= dictionary.copy() # eval mucks with it result = [] for live, chunk","numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text","= dollar + 2, 1 while level: match, pos = matchorfail(sformat, pos) tstart,","paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def","obj elif t is str: return obj.decode(encoding) elif t in [int, float, bool]:","= [\"value\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle","+ self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value)","foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\" if svars is None:","= sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0]","_test=False): \"\"\" Deletes from `table` with clauses `where` and `using`. >>> db =","% characters in the query # For backward compatability, ignore escaping when the","pos = dollar + 1 + (nextchar == \"$\") if pos < len(sformat):","ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return \"unfinished expression in","TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self):","sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2:","{}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT","test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1])","Returns current sequence ID. Set `seqname` to the ID if it's not the","= SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT *","safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object to utf-8 encoded string. >>> safestr('hello')","list to use instead of interpolating. >>> db = DB(None, {}) >>> db.query(\"SELECT","be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from tokenize","is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for","\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test:","def join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a',","WHERE x = \" + sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo WHERE","return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is quoted properly for use in","and a dictionary and interpolates the string using values from the dictionary. Returns","sql == 'WHERE': nout = 'id = ' + sqlquote(val) else: nout =","isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where,","\"\"\" __slots__ = [\"value\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'):","\"\"\" Execute SQL query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`,","isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): #","where boolean says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public","db function. Otherwise, you can pass a dictionary to the keyword argument `vars`","return sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset): return (","unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError):","+ 1, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend =","sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self, other):","= ' + sqlquote(True) + ' AND y IN ' + sqlquote([2, 3])","for i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None,","for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes a string","not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v)","\"\"\" s = [] for x in self.items: if isinstance(x, SQLParam): x =","if there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True","other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other,","'.join(keys))) for i, row in enumerate(values): if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k])","\")\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v","docstring def __init__(self, items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>>","WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark')","= matchorfail(sformat, pos + 1) elif sformat[pos] in \"([\": pos, level = pos","way... if obj is None: return 'NULL' elif obj is True: return \"'t'\"","`vars` and the function will call reparam for you. Internally, consists of `items`,","raise _ItplError(text, pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks =","produce the actual query. \"\"\" __slots__ = [\"items\"] # tested in sqlquote's docstring","else: return str(obj) def sqlify(obj): \"\"\" converts `obj` to its proper SQL version","a separate query has to be made to find # the id of","grouping) def reparam(string_, dictionary): \"\"\" Takes a string and a dictionary and interpolates","call reparam for you. Internally, consists of `items`, which is a list of","vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE name = 'Joe'\"> \"\"\" if svars",">>> db = DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo',","'t' AND y IN (2, 3)\"> \"\"\" if isinstance(a, list): return _sqllist(a) else:","and the function will call reparam for you. Internally, consists of `items`, which","if token[0] in \"([\": level = level + 1 elif token[0] in \")]\":","ID if it's not the default, or to `False` if there isn't one.","tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple rows into `tablename`. The `values` must","sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out","= ' + sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary):","the query looks already escaped if paramstyle in ['format', 'pyformat']: if '%' in","svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses","return out def update(self, tables, where, svars=None, _test=False, **values): \"\"\" Update `tables` with","tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos)","SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other,","return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles (currently supported:","paramstyle=None): \"\"\" Returns the query part of the sql query. >>> q =","== 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where =","item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items =","SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q = SQLQuery([\"SELECT * FROM test WHERE","isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1,","when the query looks already escaped if paramstyle in ['format', 'pyformat']: if '%'","# the id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1)","FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM test WHERE","'a, b'> Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'],","class SQLQuery(object): \"\"\" You can pass this sort of thing as a clause","* FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT *","x = ' + sqlquote(True) + ' AND y IN ' + sqlquote([2,","match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if","(tablename, ', '.join(keys))) for i, row in enumerate(values): if i != 0: sql_query.append(\",","else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos =","return obj elif t is str: return obj.decode(encoding) elif t in [int, float,","paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle","% table def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple rows into","vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\"> >>> db.query(\"SELECT","<sql: \"DELETE FROM foo WHERE name = 'Joe'\"> \"\"\" if svars is None:","quoted properly for use in a SQL query. >>> 'WHERE x = '","= reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None,","SET \" + sqlwhere(values, ', ') + \" WHERE \" + where) if","in any db function. Otherwise, you can pass a dictionary to the keyword","'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(),","b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return lst","are valid # make sure all rows have same keys. for v in","q(_keys) + ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query","is None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i,","foo WHERE x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo WHERE","where, svars): if isinstance(where, (int, long)): where = \"id = \" + sqlparam(where)","safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if","if a and b: return a + ' ' + b else: return","sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a `dictionary` to","unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object to","already escaped if paramstyle in ['format', 'pyformat']: if '%' in x and '%%'","if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \"\"\" Joins multiple","2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2,","using dictionary `vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style list","object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234'","use instead of interpolating. >>> db = DB(None, {}) >>> db.query(\"SELECT * FROM","= SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM","None else: return out keys = values[0].keys() #@@ make sure all keys are","eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for","appended to target instead of creating a new SQLQuery. \"\"\" if target is","is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit,",">>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'>","for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \"\"\" pass class","__init__(self, v): self.v = v def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def","paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return ':1'","if svars is None: svars = {} where = self._where(where, svars) q =","%s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects a string from `sqlquote`. >>> sqlquote('NOW()')","_test: return sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query =","% repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\" You can pass this sort","IN ' + sqlquote([2, 3]) <sql: \"WHERE x = 't' AND y IN","sort of thing as a clause in any db function. Otherwise, you can","new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ',","= {} if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars)","q <sql: \"UPDATE foo SET age = 2, name = 'bob', created =","unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def","self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the query part","says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping",">>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return lst else:","2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a':","def values(self): \"\"\" Returns the values of the parameters used in the sql","a + ' ' + b else: return a or b return xjoin(sql,","where = self._where(where, svars) q = 'DELETE FROM ' + table if using:","\"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query` using dictionary","WHERE x = 'f'\"> >>> db.query(\"SELECT * FROM foo WHERE x = \"","break nextchar = sformat[dollar + 1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos,","in SQLQuery. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")]) >>>","is provided, the items are appended to target instead of creating a new","and setting `values`. >>> db = DB(None, {}) >>> name = 'Joseph' >>>","0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is","2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat,","with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise,","list of dictioanries, one for each row to be inserted, each with the","pos = 0 while 1: dollar = sformat.find(\"$\", pos) if dollar < 0:","= 3\"> >>> 'WHERE x = ' + sqlquote(True) + ' AND y","% tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self):","False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases,","== True and hash(1) == hash(True)` # we have to do this the","isinstance(sql_query, tuple): # for some databases, a separate query has to be made","def _where(self, where, svars): if isinstance(where, (int, long)): where = \"id = \"","db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>>","svars is None: svars = {} if not processed and not isinstance(sql_query, SQLQuery):",">>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE name","Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj,","safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj,","return repr(obj) def sqllist(lst): \"\"\" Converts the arguments for use in something like","object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2)","sure all keys are valid # make sure all rows have same keys.","not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values): \"\"\"","== 'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle is","__str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam","\"\"\" Ensures `a` is quoted properly for use in a SQL query. >>>","= \"id = \" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) ==","\"([\": pos, level = pos + 1, 1 while level: match, pos =","q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT","the keyword argument `vars` and the function will call reparam for you. Internally,","_get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT VALUES\" % table def multiple_insert(self, tablename,","* FROM foo WHERE x = 'f'\"> \"\"\" if svars is None: svars","other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' %","\"id = \" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2:","which get concatenated to produce the actual query. \"\"\" __slots__ = [\"items\"] #","Otherwise, each clause can be a SQLQuery. >>> db = DB(None, {}) >>>","qmark, numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self)","db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name',","query(self, paramstyle=None): \"\"\" Returns the query part of the sql query. >>> q","= NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\" if","SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM test WHERE name='joe'\"> >>> q.query() 'SELECT","2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id =","in x: x = x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self): \"\"\" Returns","while pos < len(sformat): if sformat[pos] == \".\" and \\ pos + 1","not in x: x = x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self): \"\"\"","prefix: target_items.append(prefix) for i, item in enumerate(items): if i != 0: target_items.append(sep) if","FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \"\"\"","y IN ' + sqlquote([2, 3]) <sql: \"WHERE x = 't' AND y","svars) for sql, val in sql_clauses if val is not None] qout =","properly for use in a SQL query. >>> 'WHERE x = ' +","foo WHERE x = 'f'\"> \"\"\" if svars is None: svars = {}","<reponame>handsome3163/H2Dgame-Firefly<gh_stars>100-1000 #coding:utf8 ''' Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import","True: return \"'t'\" elif obj is False: return \"'f'\" elif datetime and isinstance(obj,","safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class","`offset`. Uses vars to interpolate. Otherwise, each clause can be a SQLQuery. >>>","pos + 1, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend","'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a',","ID. Set `seqname` to the ID if it's not the default, or to","obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or","matchorfail(sformat, pos + 1) elif sformat[pos] in \"([\": pos, level = pos +","values(self): \"\"\" Returns the values of the parameters used in the sql query.","def delete(self, table, where, using=None, svars=None, _test=False): \"\"\" Deletes from `table` with clauses","into `tablename`. Returns current sequence ID. Set `seqname` to the ID if it's","v): self.v = v def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self):","= type(obj) if t is unicode: return obj elif t is str: return","level = level + 1 elif token == \"}\": level = level -","return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any given object","<sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=',","v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items)","'') class UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles (currently supported: qmark, numeric,","`False` if there isn't one. >>> db = DB(None, {}) >>> q =","WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>>","\"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\"","offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER","['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self, value): self.value = value def get_marker(self,","paramstyles (currently supported: qmark, numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self,","other): if isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items +","we have to do this the hard way... if obj is None: return","'(1, 2, 3)'> \"\"\" items = [] items.append('(') for i, v in enumerate(values):","SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group,","%s (%s) VALUES ' % (tablename, ', '.join(keys))) for i, row in enumerate(values):","using: q += ' USING ' + sqllist(using) if where: q += '","SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self):","if match is None: raise _ItplError(text, pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\"","database. \"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query` using","%s' \"\"\" return SQLQuery.join([k + ' = ' + sqlparam(v) for k, v","= 'DELETE FROM ' + table if using: q += ' USING '","FROM test WHERE name=?' \"\"\" s = [] for x in self.items: if","enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a):","') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \"INSERT","DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql:","len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the query part of the sql query.","tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql,","if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \",","`sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style","= ' + sqlquote(True) + ' AND y = ' + sqlquote(3) <sql:","NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the","table def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple rows into `tablename`.","def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self,","if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically","staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()]) except","be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If","if val is not None] qout = SQLQuery.join(clauses) if _test: return qout return","'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)])","enumerate(values): if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\",","= DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\"name\": \"foo\", \"email\":","WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value for i in self.items","FROM test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value for i","elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else:",">>> q.values() ['joe'] \"\"\" return [i.value for i in self.items if isinstance(i, SQLParam)]","#@@ make sure all keys are valid # make sure all rows have","'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple))",">>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" # because `1 == True and","pos): match = tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return","k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes a string and","FROM ' + table if using: q += ' USING ' + sqllist(using)","'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE","items = [] items.append('(') for i, v in enumerate(values): if i != 0:","query. >>> 'WHERE x = ' + sqlquote(True) + ' AND y =","items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is quoted","string using values from the dictionary. Returns an `SQLQuery` for the result. >>>","rows into `tablename`. The `values` must be a list of dictioanries, one for",">>> safestr(2) '2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return","self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query,","ignore escaping when the query looks already escaped if paramstyle in ['format', 'pyformat']:","matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos] == \".\" and","= pos def __str__(self): return \"unfinished expression in %s at char %d\" %","SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test",">>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif","using `vars`) and setting `values`. >>> db = DB(None, {}) >>> name =","delete(self, table, where, using=None, svars=None, _test=False): \"\"\" Deletes from `table` with clauses `where`","sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return lst else: return","for each row to be inserted, each with the same set of keys.","<sql: \"WHERE x = 't' AND y IN (2, 3)\"> \"\"\" if isinstance(a,","one. >>> db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'),","sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos < len(sformat): if","and \\ pos + 1 < len(sformat) and sformat[pos + 1] in namechars:","+ 1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar +","foo (age, name, created) VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO foo","dictionary.copy() # eval mucks with it result = [] for live, chunk in",">>> db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True)","_test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return","row in enumerate(values): if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in","nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while","to interpolate it. If `processed=True`, `vars` is a `reparam`-style list to use instead","def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral:","query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None,","basestring): items = [other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self,","'NOW()'> \"\"\" def __init__(self, v): self.v = v def __repr__(self): return self.v class","= match.regs[3] token = sformat[tstart:tend] if token[0] in \"([\": level = level +","<sql: 'NOW()'> \"\"\" def __init__(self, v): self.v = v def __repr__(self): return self.v","' + sqlquote(True) + ' AND y IN ' + sqlquote([2, 3]) <sql:","sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val,","SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self,","datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8')","return a + ' ' + b else: return a or b return","for k in keys], sep=\", \", target=sql_query, prefix=\"(\", suffix=\")\") if _test: return sql_query","a database. \"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query`","('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if","obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\" Converts the arguments for use in something","sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format string and returns a list of","dictionary): \"\"\" Takes a string and a dictionary and interpolates the string using","= level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in","value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?'","' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val)","__unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\"","a `reparam`-style list to use instead of interpolating. >>> db = DB(None, {})","i, row in enumerate(values): if i != 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k","expression in %s at char %d\" % ( repr(self.text), self.pos) class SQLParam(object): \"\"\"","try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None","matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \"([\":","= SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return","repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\" You can pass this sort of","1 < len(sformat) and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat,","is quoted properly for use in a SQL query. >>> 'WHERE x =","nextchar = sformat[dollar + 1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level","'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\" if","all keys are valid # make sure all rows have same keys. for","= other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if","insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values` into `tablename`. Returns current sequence","svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id =","items are appended to target instead of creating a new SQLQuery. \"\"\" if","__repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects a string from","FROM foo WHERE name = 'Joe'\"> \"\"\" if svars is None: svars =","test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is None:","'(a, b)'> If target argument is provided, the items are appended to target","= \" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where","be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT","matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token == \"{\":","0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target","__radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return","update(self, tables, where, svars=None, _test=False, **values): \"\"\" Update `tables` with clause `where` (interpolated","name = 'Joseph'\"> >>> q.query() 'UPDATE foo SET age = %s, name =","import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object to unicode string.","clause in any db function. Otherwise, you can pass a dictionary to the","'bob'] \"\"\" def q(x): return \"(\" + x + \")\" if values: _keys","def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark':","nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else:","Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables,","where='name = $name', vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE name = 'Joe'\">","$name', vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE name = 'Joe'\"> \"\"\" if","SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT *","isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items,","in \")]\": level = level - 1 else: break chunks.append((1, sformat[dollar + 1:pos]))","join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x in","= list(items.items) else: self.items = [items] # Take care of SQLLiterals for i,","WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM test WHERE name='joe'\"> >>>","raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() +","can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'>","\" WHERE \" + where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor,","= 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s","DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'],","or to `False` if there isn't one. >>> db = DB(None, {}) >>>","Inserts multiple rows into `tablename`. The `values` must be a list of dictioanries,","a list of strings and SQLParams, which get concatenated to produce the actual","= DB(None, {}) >>> db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT * FROM","for v in values] if seqname is False: return None else: return out","self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query() def","INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for i, row in","else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout","1, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3]","isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join)","test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \"\"\" s","q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>>","return 'NULL' elif obj is True: return \"'t'\" elif obj is False: return","`vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style list to use","Converts any given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234')","elif obj is False: return \"'f'\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat())","return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif","match.regs[3] token = sformat[tstart:tend] if token == \"{\": level = level + 1","datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object to unicode string. >>>","= 't'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's IN (1, 2)'>","x = 't' AND y = 3\"> >>> 'WHERE x = ' +","sformat[dollar + 1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar","token[0] in \"([\": level = level + 1 elif token[0] in \")]\": level","VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \"\"\" def q(x): return \"(\"","_test=True) >>> q <sql: \"UPDATE foo SET age = 2, name = 'bob',","= 'Joseph'\"> >>> q.query() 'UPDATE foo SET age = %s, name = %s,","r\"\"\" Converts any given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>>","1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar +","reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset):","'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding)","<sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM","[i.value for i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None,","def __len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the query part of","sql, val, svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout =","select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what`","any given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>>","\"s = 't'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's IN (1,","obj is None: return 'NULL' elif obj is True: return \"'t'\" elif obj","if t is unicode: return obj elif t is str: return obj.decode(encoding) elif","s = [] for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle)","format, pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text =",">>> q <sql: \"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\">","(%s, %s, NOW())' >>> q.values() [2, 'bob'] \"\"\" def q(x): return \"(\" +","sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" # because `1 ==","if token == \"{\": level = level + 1 elif token == \"}\":","it. If `processed=True`, `vars` is a `reparam`-style list to use instead of interpolating.","SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def","dollar < 0: break nextchar = sformat[dollar + 1] if nextchar == \"{\":","\"\"\" Returns the query part of the sql query. >>> q = SQLQuery([\"SELECT","<sql: \"UPDATE foo SET age = 2, name = 'bob', created = NOW()","is None: raise _ItplError(text, pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\";",">>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM foo,","instead of creating a new SQLQuery. \"\"\" if target is None: target =","for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] =","\"\"\" Takes a format string and returns a list of 2-tuples of the","3]) <sql: '(1, 2, 3)'> \"\"\" items = [] items.append('(') for i, v","items.append('(') for i, v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v))","list of strings and SQLParams, which get concatenated to produce the actual query.",">>> SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', '","['joe'] \"\"\" return [i.value for i in self.items if isinstance(i, SQLParam)] def join(items,","def __add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items","instead of interpolating. >>> db = DB(None, {}) >>> db.query(\"SELECT * FROM foo\",","the same set of keys. Returns the list of ids of the inserted","`items`, which is a list of strings and SQLParams, which get concatenated to","[items] # Take care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item,","\" SET \" + sqlwhere(values, ', ') + \" WHERE \" + where)","SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self,","hard way... if obj is None: return 'NULL' elif obj is True: return","self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery):","= NOW() WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE foo SET age =","Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ',","IN (1, 2)'> \"\"\" dictionary = dictionary.copy() # eval mucks with it result","'Joseph'] \"\"\" if svars is None: svars = {} where = self._where(where, svars)","'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" # because `1 == True","dictionary to the keyword argument `vars` and the function will call reparam for",">>> 'WHERE x = ' + sqlquote(True) + ' AND y IN '","' + sqlquote([2, 3]) <sql: \"WHERE x = 't' AND y IN (2,","SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is None: self.items = [] elif isinstance(items,","FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is","'%' in x and '%%' not in x: x = x.replace('%', '%%') s.append(x)","for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x","match, pos = matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos]","if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\"","u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if t is unicode: return","{} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql,","find # the id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor,","cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b","* FROM test WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def","row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try:","sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar == \"$\") if","keys. for v in values: if v.keys() != keys: raise ValueError, 'Bad data'","you. Internally, consists of `items`, which is a list of strings and SQLParams,","of the form (boolean, string) where boolean says whether string should be evaled","strings and SQLParams, which get concatenated to produce the actual query. \"\"\" __slots__","`limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause can be a","FROM foo\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT * FROM foo","r\"\"\" Converts any given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2)","return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__')","Returns an `SQLQuery` for the result. >>> reparam(\"s = $s\", dict(s=True)) <sql: \"s","tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None: raise","x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x =","of keys. Returns the list of ids of the inserted rows. Set `seqname`","sqlparam = SQLParam class SQLQuery(object): \"\"\" You can pass this sort of thing","care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value,","float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else:","<sql: \"WHERE x = 't' AND y = 3\"> >>> 'WHERE x =","elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj)","len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where","= SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ')","pos = matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos] ==","is False: return None else: return out keys = values[0].keys() #@@ make sure","$s\", dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s IN $s\", dict(s=[1, 2])) <sql:","name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \"\"\" s = []","sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\"> \"\"\" if","sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1])","'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \"\"\" converts","backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars) def","return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding)","'1'> \"\"\" if items is None: self.items = [] elif isinstance(items, list): self.items","query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars` is a","self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out =","* FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT","from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \"\"\" from tokenize import tokenprog tokenprog =","= staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()])","not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def","name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE foo SET age","use in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>>","return None else: return out keys = values[0].keys() #@@ make sure all keys","= level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar","'?' elif paramstyle == 'numeric': return ':1' elif paramstyle is None or paramstyle","WHERE name = 'Joe'\"> \"\"\" if svars is None: svars = {} where","target argument is provided, the items are appended to target instead of creating","for v in values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query","FROM foo WHERE x = 'f'\"> >>> db.query(\"SELECT * FROM foo WHERE x","def reparam(string_, dictionary): \"\"\" Takes a string and a dictionary and interpolates the","tuple): # for some databases, a separate query has to be made to","where, using=None, svars=None, _test=False): \"\"\" Deletes from `table` with clauses `where` and `using`.","SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix arguments can","\"\"\" Update `tables` with clause `where` (interpolated using `vars`) and setting `values`. >>>","the values of the parameters used in the sql query. >>> q =","'<EMAIL>')\"> \"\"\" if not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename,","person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values: return","result = [] for live, chunk in _interpolate(string_): if live: v = eval(chunk,","pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \"([\": pos, level =","WHERE name='joe'\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe']","- 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1]))","'2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif","values[0].keys() #@@ make sure all keys are valid # make sure all rows","= reparam(val, svars) def xjoin(a, b): if a and b: return a +","def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other]","if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items else:","{} where = self._where(where, svars) q = 'DELETE FROM ' + table if","<sql: \"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\"> >>> q.query()","return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle is None or","SQLQuery): pass else: where = reparam(where, svars) return where def select(self, tables, svars=None,",">>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\"name\":","of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral):","concatenated to produce the actual query. \"\"\" __slots__ = [\"items\"] # tested in","') + \" WHERE \" + where) if _test: return query db_cursor =","(public domain, Ka-Ping Yee) \"\"\" from tokenize import tokenprog tokenprog = tokenprog def","`values` into `tablename`. Returns current sequence ID. Set `seqname` to the ID if","__len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the query part of the","suffix=')') <sql: '(a, b)'> If target argument is provided, the items are appended","\"\"\" raised for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \"\"\"","svars = {} where = self._where(where, svars) query = ( \"UPDATE \" +","+ \" SET \" + sqlwhere(values, ', ') + \" WHERE \" +","= [\"items\"] # tested in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a new","target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join","= [] items.append('(') for i, v in enumerate(values): if i != 0: items.append(',","q <sql: \"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\"> >>>","and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what,","`tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate.","self.items = [items] # Take care of SQLLiterals for i, item in enumerate(self.items):","and SQLParams, which get concatenated to produce the actual query. \"\"\" __slots__ =","tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val,","[items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] # Take","if v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s","pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text","\" + sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\">","< len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts","'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE","obj is False: return \"'f'\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else:","in values] if seqname is False: return None else: return out keys =","isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format","' + sqlquote(True) + ' AND y = ' + sqlquote(3) <sql: \"WHERE","1] in namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in","\"UPDATE \" + sqllist(tables) + \" SET \" + sqlwhere(values, ', ') +","'bob', 'Joseph'] \"\"\" if svars is None: svars = {} where = self._where(where,","live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception):","sqlquote(True) + ' AND y IN ' + sqlquote([2, 3]) <sql: \"WHERE x","query. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.query()","with clauses `where` and `using`. >>> db = DB(None, {}) >>> name =","if isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values): \"\"\" >>>","False: return None else: return out keys = values[0].keys() #@@ make sure all","<sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT * FROM foo WHERE x =",">>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>>","self.items = items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items","(boolean, string) where boolean says whether string should be evaled or not. from","with the same set of keys. Returns the list of ids of the",">>> sqlify(3) '3' \"\"\" # because `1 == True and hash(1) == hash(True)`","sformat[pos:dollar])) pos, level = dollar + 2, 1 while level: match, pos =","reparam(string_, dictionary): \"\"\" Takes a string and a dictionary and interpolates the string","`values`. >>> db = DB(None, {}) >>> name = 'Joseph' >>> q =","name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \"DELETE FROM","_ItplError(text, pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = []","= $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE foo","<sql: '1'> \"\"\" if items is None: self.items = [] elif isinstance(items, list):","the sql query. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')])","db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT *","y = 3\"> >>> 'WHERE x = ' + sqlquote(True) + ' AND","1: dollar = sformat.find(\"$\", pos) if dollar < 0: break nextchar = sformat[dollar","<sql: 's IN (1, 2)'> \"\"\" dictionary = dictionary.copy() # eval mucks with",">>> q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True)","- 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0,","in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result,","t is str: return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj)","sformat[tstart:tend] if token == \"{\": level = level + 1 elif token ==","to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\"","tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass","'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql:","hash(True)` # we have to do this the hard way... if obj is","namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos <","FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\" if svars is","isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars) def xjoin(a, b):","supported: qmark, numeric, format, pyformat) \"\"\" pass class _ItplError(ValueError): def __init__(self, text, pos):","if target is None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix)","query has to be made to find # the id of the inserted","other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented","to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2'","a string and a dictionary and interpolates the string using values from the","foo'> >>> db.query(\"SELECT * FROM foo WHERE x = $x\", vars=dict(x='f'), _test=True) <sql:","NOW())\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())'","isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where,","dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for unsupported","query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query` using dictionary `vars` to interpolate","result. >>> reparam(\"s = $s\", dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s IN","' % (tablename, ', '.join(keys))) for i, row in enumerate(values): if i !=","sqlify(3) '3' \"\"\" # because `1 == True and hash(1) == hash(True)` #","import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object to","if svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group,","unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator","db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\",","+ ' ' + b else: return a or b return xjoin(sql, nout)","\".\" and \\ pos + 1 < len(sformat) and sformat[pos + 1] in","x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1))","'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"]","svars = {} if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query,","SET age = %s, name = %s, created = NOW() WHERE name =","SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items = [other] else:","of 2-tuples of the form (boolean, string) where boolean says whether string should","{}) >>> db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT * FROM foo'> >>>","= 't' AND y = 3\"> >>> 'WHERE x = ' + sqlquote(True)","db = DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo', where='name","sqlquote(a): \"\"\" Ensures `a` is quoted properly for use in a SQL query.","= [] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items =","b else: return a or b return xjoin(sql, nout) def _where(self, where, svars):","q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values()","+ sqlquote(True) + ' AND y IN ' + sqlquote([2, 3]) <sql: \"WHERE","* FROM foo WHERE x = 'f'\"> >>> db.query(\"SELECT * FROM foo WHERE","break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar","[\"items\"] # tested in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a new SQLQuery.","= items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items =","_sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \"\"\" items =","+ table if using: q += ' USING ' + sqllist(using) if where:","suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql:","else: return ', '.join(lst) def _sqllist(values): \"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1,","' + table if using: q += ' USING ' + sqllist(using) if","q.query() 'UPDATE foo SET age = %s, name = %s, created = NOW()","\"\"\" return SQLQuery.join([k + ' = ' + sqlparam(v) for k, v in",">>> db = DB(None, {}) >>> db.query(\"SELECT * FROM foo\", _test=True) <sql: 'SELECT","FROM foo'> >>> db.query(\"SELECT * FROM foo WHERE x = $x\", vars=dict(x='f'), _test=True)","group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars):","if isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id = '","return chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a `dictionary` to an","v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s)","'%%' not in x: x = x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self):","+ where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not","% tablename + q(_keys) + ' VALUES ' + q(_values) else: sql_query =","return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)):","return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>'","%s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\" You can pass this","obj) else: return str(obj) def sqlify(obj): \"\"\" converts `obj` to its proper SQL","== \"{\": level = level + 1 elif token == \"}\": level =","== \"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while level:","item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else:",">>> db.query(\"SELECT * FROM foo WHERE x = \" + sqlquote('f'), _test=True) <sql:","SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values()","2])) <sql: 's IN (1, 2)'> \"\"\" dictionary = dictionary.copy() # eval mucks","self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return","values from the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\"s =","else: nout = reparam(val, svars) def xjoin(a, b): if a and b: return","str: return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj,","`using`. >>> db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name","[] pos = 0 while 1: dollar = sformat.find(\"$\", pos) if dollar <","sformat[tstart:tend] if token[0] in \"([\": level = level + 1 elif token[0] in","sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\" # because `1 == True and hash(1)","WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id","= sformat.find(\"$\", pos) if dollar < 0: break nextchar = sformat[dollar + 1]","where = \"id = \" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where)","return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v","= 't' AND y IN (2, 3)\"> \"\"\" if isinstance(a, list): return _sqllist(a)","VALUES ' % (tablename, ', '.join(keys))) for i, row in enumerate(values): if i","AND y = ' + sqlquote(3) <sql: \"WHERE x = 't' AND y","import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if","Otherwise, you can pass a dictionary to the keyword argument `vars` and the","escaped if paramstyle in ['format', 'pyformat']: if '%' in x and '%%' not","= db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q","+ 1 elif token == \"}\": level = level - 1 chunks.append((1, sformat[dollar","\"\"\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \"\"\" items = []","because `1 == True and hash(1) == hash(True)` # we have to do","repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \"\"\"","nout) def _where(self, where, svars): if isinstance(where, (int, long)): where = \"id =","+ (nextchar == \"$\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def","= self._where(where, svars) q = 'DELETE FROM ' + table if using: q","q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \"\"\" s = [] for x","SQLQuery): nout = val else: nout = reparam(val, svars) def xjoin(a, b): if","the inserted rows. Set `seqname` to the ID if it's not the default,","`1 == True and hash(1) == hash(True)` # we have to do this","q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self, value): self.value = value def","actual query. \"\"\" __slots__ = [\"items\"] # tested in sqlquote's docstring def __init__(self,","gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout","sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1","#coding:utf8 ''' Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime","test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql: \"SELECT * FROM test WHERE name='joe'\">","tables, where, svars=None, _test=False, **values): \"\"\" Update `tables` with clause `where` (interpolated using","VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES","query # For backward compatability, ignore escaping when the query looks already escaped","return SQLQuery.join([k + ' = ' + sqlparam(v) for k, v in dictionary.items()],","if isinstance(sql_query, tuple): # for some databases, a separate query has to be","`where` (interpolated using `vars`) and setting `values`. >>> db = DB(None, {}) >>>","'bob', created = NOW() WHERE name = 'Joseph'\"> >>> q.query() 'UPDATE foo SET","2, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3]","= SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return","it's not the default, or to `False` if there isn't one. >>> db","test WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self, value):","if _test: return sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query","keys. Returns the list of ids of the inserted rows. Set `seqname` to","[2, 'bob'] \"\"\" def q(x): return \"(\" + x + \")\" if values:","isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items",">>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>>","SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE","b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)): where","\"\"\" converts `obj` to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True)","`where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause","of strings and SQLParams, which get concatenated to produce the actual query. \"\"\"","pos) if match is None: raise _ItplError(text, pos) return match, match.end() namechars =","elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where def select(self,","\"\"\" t = type(obj) if t is unicode: return obj elif t is","q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\"","* FROM foo\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\"SELECT * FROM","string. >>> safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj,","+ sqlwhere(values, ', ') + \" WHERE \" + where) if _test: return","SQLQuery(object): \"\"\" You can pass this sort of thing as a clause in","clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each","name, created) VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO foo (age, name,","Ka-Ping Yee) \"\"\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos):","for use in a SQL query. >>> 'WHERE x = ' + sqlquote(True)","__slots__ = [\"items\"] # tested in sqlquote's docstring def __init__(self, items=None): r\"\"\"Creates a","<sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\"","' = ' + sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_,","+ sqlquote(3) <sql: \"WHERE x = 't' AND y = 3\"> >>> 'WHERE","self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname","= DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo', where='name =","val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val,","__str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' %","seqname=None, _test=False, **values): \"\"\" Inserts `values` into `tablename`. Returns current sequence ID. Set",">>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v): self.v","make sure all keys are valid # make sure all rows have same","db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql:","= match.regs[3] token = sformat[tstart:tend] if token == \"{\": level = level +","# for some databases, a separate query has to be made to find","self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values): \"\"\" Update `tables`","SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if","to the ID if it's not the default, or to `False` if there","chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar == \"$\")","SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND","same keys. for v in values: if v.keys() != keys: raise ValueError, 'Bad","for v in values.values()], ', ') sql_query = \"INSERT INTO %s \" %","level = level + 1 elif token[0] in \")]\": level = level -","grouping=' AND '): \"\"\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`.","consists of `items`, which is a list of strings and SQLParams, which get","if '%' in x and '%%' not in x: x = x.replace('%', '%%')","values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()],","reparam(\"s IN $s\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \"\"\" dictionary =","values = [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values,","def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \"\"\" Protects a string","' + sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\"","def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\"","elif t is str: return obj.decode(encoding) elif t in [int, float, bool]: return","\"\"\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes","x = 'f'\"> >>> db.query(\"SELECT * FROM foo WHERE x = \" +","AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id =","else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception:","= [other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if","of the sql query. >>> q = SQLQuery([\"SELECT * FROM test WHERE name=\",","Uses vars to interpolate. Otherwise, each clause can be a SQLQuery. >>> db","\"DELETE FROM foo WHERE name = 'Joe'\"> \"\"\" if svars is None: svars","like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>>","FROM test WHERE name='joe'\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>>","in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x)","enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if","for i, v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')')","raised for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \"\"\" pass","isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if","a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM","else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised for unsupported db paramstyles","\"\"\" Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`.","inserted rows. Set `seqname` to the ID if it's not the default, or","return out keys = values[0].keys() #@@ make sure all keys are valid #","provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target","list of ids of the inserted rows. Set `seqname` to the ID if","with clause `where` (interpolated using `vars`) and setting `values`. >>> db = DB(None,","svars=None, _test=False): \"\"\" Deletes from `table` with clauses `where` and `using`. >>> db","values=values, _test=True) <sql: \"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\">","pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query` using dictionary `vars`","is None: self.items = [] elif isinstance(items, list): self.items = items elif isinstance(items,","WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'> >>>","SQL query. >>> 'WHERE x = ' + sqlquote(True) + ' AND y","text, pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return \"unfinished","where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where def","INTO %s \" % tablename + q(_keys) + ' VALUES ' + q(_values)","= target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if i !=","return ':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s'","= $name', vars=locals(), _test=True) <sql: \"DELETE FROM foo WHERE name = 'Joe'\"> \"\"\"","' + b else: return a or b return xjoin(sql, nout) def _where(self,","to do this the hard way... if obj is None: return 'NULL' elif","databases, a separate query has to be made to find # the id","= x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self): \"\"\" Returns the values of","= self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a separate","`table` with clauses `where` and `using`. >>> db = DB(None, {}) >>> name","= sformat[tstart:tend] if token == \"{\": level = level + 1 elif token","= {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses =","self._where(where, svars) query = ( \"UPDATE \" + sqllist(tables) + \" SET \"","Returns the list of ids of the inserted rows. Set `seqname` to the","list(items.items) else: self.items = [items] # Take care of SQLLiterals for i, item","\"\"\" if items is None: self.items = [] elif isinstance(items, list): self.items =","\"\"\" if svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where,","self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\" pass def query(self,","string and returns a list of 2-tuples of the form (boolean, string) where","if paramstyle in ['format', 'pyformat']: if '%' in x and '%%' not in","elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj):","= level + 1 elif token == \"}\": level = level - 1","'<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\" You can pass","x.replace('%', '%%') s.append(x) return \"\".join(s) def values(self): \"\"\" Returns the values of the","\"\"\" items = [] items.append('(') for i, v in enumerate(values): if i !=","the arguments for use in something like a WHERE clause. >>> sqllist(['a', 'b'])","email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values: return [] if","def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None: raise _ItplError(text,","if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values]","return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format string and returns a list","data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys)))","foo.bar_id = bar.id LIMIT 5'> \"\"\" if svars is None: svars = {}","The `values` must be a list of dictioanries, one for each row to","Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'>","'SELECT * FROM foo'> >>> db.query(\"SELECT * FROM foo WHERE x = $x\",","\"\"\" Deletes from `table` with clauses `where` and `using`. >>> db = DB(None,","in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self,","+ \")\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for","format string and returns a list of 2-tuples of the form (boolean, string)","_test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\"> >>> db.query(\"SELECT *","query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def","WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is None: self.items","VALUES\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts multiple rows","for you. Internally, consists of `items`, which is a list of strings and","a list of 2-tuples of the form (boolean, string) where boolean says whether","'b'}).query() 'a = %s AND b = %s' \"\"\" return SQLQuery.join([k + '","can pass this sort of thing as a clause in any db function.","a new SQLQuery. \"\"\" if target is None: target = SQLQuery() target_items =","* FROM test WHERE name=\", SQLParam('joe')]) >>> q.values() ['joe'] \"\"\" return [i.value for","# iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \"\"\" converts `obj`","WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \"\"\" s =","values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for","return target join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for","raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' %","Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname` to the ID","x = \" + sqlquote('f'), _test=True) <sql: \"SELECT * FROM foo WHERE x","chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a `dictionary`","else: return a or b return xjoin(sql, nout) def _where(self, where, svars): if","safestr(2) '2' \"\"\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj","q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam('joe')]) >>> q.query() 'SELECT *","processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self,","1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2,","__init__(self): \"\"\"Creates a database. \"\"\" pass def query(self, sql_query,processed=False, svars=None): \"\"\" Execute SQL","from `table` with clauses `where` and `using`. >>> db = DB(None, {}) >>>","if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in","parameters used in the sql query. >>> q = SQLQuery([\"SELECT * FROM test","q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test","self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for","Ensures `a` is quoted properly for use in a SQL query. >>> 'WHERE","( \"UPDATE \" + sqllist(tables) + \" SET \" + sqlwhere(values, ', ')","<sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a","= sformat[tstart:tend] if token[0] in \"([\": level = level + 1 elif token[0]","__init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return","if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1","prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided, the items are","processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \"\"\" Inserts `values` into `tablename`. Returns","WHERE name=%s' >>> q.values() ['joe'] \"\"\" __slots__ = [\"value\"] def __init__(self, value): self.value","[{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql:","sql_clauses if val is not None] qout = SQLQuery.join(clauses) if _test: return qout","' USING ' + sqllist(using) if where: q += ' WHERE ' +","created) VALUES (2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO foo (age, name, created)","foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM","to find # the id of the inserted row. q1, q2 = sql_query","!= 0: sql_query.append(\", \") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\", \", target=sql_query, prefix=\"(\",","__repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \"\"\" You","t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode):","list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \"\"\" Takes a format string","None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset)","elif isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) #","+ sqllist(using) if where: q += ' WHERE ' + where return q","return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns the query part of the sql","in sql_clauses if val is not None] qout = SQLQuery.join(clauses) if _test: return","* FROM foo'> >>> db.query(\"SELECT * FROM foo WHERE x = $x\", vars=dict(x='f'),","VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values: return [] if not",">>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if t is","there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>>","a dictionary and interpolates the string using values from the dictionary. Returns an","eval mucks with it result = [] for live, chunk in _interpolate(string_): if","if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False):","where = self._where(where, svars) query = ( \"UPDATE \" + sqllist(tables) + \"","items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \"\"\" Ensures `a` is quoted properly for","'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a =","`tablename`. Returns current sequence ID. Set `seqname` to the ID if it's not","\"\"\" if target is None: target = SQLQuery() target_items = target.items if prefix:","= sformat[dollar + 1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar])) pos, level =","sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos","a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT *","'): \"\"\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id':","\"\"\" Returns the values of the parameters used in the sql query. >>>","a and b: return a + ' ' + b else: return a","False: return \"'f'\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj,","[] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in","''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\"\"\" Converts any given object","token = sformat[tstart:tend] if token == \"{\": level = level + 1 elif","<sql: '(1, 2, 3)'> \"\"\" items = [] items.append('(') for i, v in",">>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \"\"\" s = [] for","where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val","None: svars = {} where = self._where(where, svars) query = ( \"UPDATE \"","Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3})","reparam(\"s = $s\", dict(s=True)) <sql: \"s = 't'\"> >>> reparam(\"s IN $s\", dict(s=[1,","if seqname is False: return None else: return out keys = values[0].keys() #@@","have same keys. for v in values: if v.keys() != keys: raise ValueError,","!= keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES","sqllist(lst): \"\"\" Converts the arguments for use in something like a WHERE clause.",">>> q.values() [2, 'bob', 'Joseph'] \"\"\" if svars is None: svars = {}","return NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \"\"\" Returns","SQLQuery. \"\"\" if target is None: target = SQLQuery() target_items = target.items if","\"'NOW()'\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v): self.v = v def","svars) return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None,","string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t =","SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def query(self,","a dictionary to the keyword argument `vars` and the function will call reparam","__slots__ = [\"value\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if","1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar]))","target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'>","the function will call reparam for you. Internally, consists of `items`, which is","WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc'","\"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \"INSERT INTO person","('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)):","prefix=\"(\", suffix=\")\") if _test: return sql_query db_cursor = self._db_cursor() if seqname is not","in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a')","proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3' \"\"\"","Takes a string and a dictionary and interpolates the string using values from","def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects","svars is None: svars = {} where = self._where(where, svars) q = 'DELETE","out def update(self, tables, where, svars=None, _test=False, **values): \"\"\" Update `tables` with clause","\"SELECT * FROM test WHERE name='joe'\"> >>> q.query() 'SELECT * FROM test WHERE","WHERE foo.bar_id = bar.id LIMIT 5'> \"\"\" if svars is None: svars =","mucks with it result = [] for live, chunk in _interpolate(string_): if live:","tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \"([\": level = level","prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(',","= pos + 1, 1 while level: match, pos = matchorfail(sformat, pos) tstart,",">>> q.values() [2, 'bob'] \"\"\" def q(x): return \"(\" + x + \")\"","bar.id\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id","query looks already escaped if paramstyle in ['format', 'pyformat']: if '%' in x","isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def","$x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo WHERE x = 'f'\"> >>>","converts `obj` to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\"","is False: return \"'f'\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if","\"\"\" def __init__(self, v): self.v = v def __repr__(self): return self.v class SQLProducer:","dictionary `vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style list to","SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query","the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\"s = $s\", dict(s=True))","if using: q += ' USING ' + sqllist(using) if where: q +=","self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items]","', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided, the","sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \"\"\" Takes a","`SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'>","sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>>","'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test","None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self,","q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out =","(2, 'bob', NOW())\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s,","None: raise _ItplError(text, pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks","made to find # the id of the inserted row. q1, q2 =","safestr('hello') 'hello' >>> safestr(u'\\u1234') '\\xe1\\x88\\xb4' >>> safestr(2) '2' \"\"\" if isinstance(obj, unicode): return","= eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \"\"\" raised","ids of the inserted rows. Set `seqname` to the ID if it's not","None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item","out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None if","def __init__(self, v): self.v = v def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\"","%s DEFAULT VALUES\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \"\"\" Inserts","tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a separate query has","= \"INSERT INTO %s \" % tablename + q(_keys) + ' VALUES '","def _str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError,","svars) return sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset): return","return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items = [other]","other def __radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value) def","x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \"\"\" if items is None: self.items =","= reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group, order, limit,","escape % characters in the query # For backward compatability, ignore escaping when","**values): \"\"\" Update `tables` with clause `where` (interpolated using `vars`) and setting `values`.","escaping when the query looks already escaped if paramstyle in ['format', 'pyformat']: if","sqllist(u'abc') u'abc' \"\"\" if isinstance(lst, basestring): return lst else: return ', '.join(lst) def","WHERE \" + where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query)","<sql: 'a, b'> Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a',","sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \"\"\" if isinstance(lst,","dictioanries, one for each row to be inserted, each with the same set","self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1)","WHERE x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo WHERE x","is a `reparam`-style list to use instead of interpolating. >>> db = DB(None,","'<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\" if not values: return [] if not self.supports_multiple_insert: out","the parameters used in the sql query. >>> q = SQLQuery([\"SELECT * FROM","('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET',","interpolating. >>> db = DB(None, {}) >>> db.query(\"SELECT * FROM foo\", _test=True) <sql:","return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False):","where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions:","= DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q","= matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos] == \".\"","BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val,","compatability, ignore escaping when the query looks already escaped if paramstyle in ['format',","sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset): return ( ('SELECT',","def __repr__(self): return self.v class SQLProducer: \"\"\"Database\"\"\" def __init__(self): \"\"\"Creates a database. \"\"\"","match is None: raise _ItplError(text, pos) return match, match.end() namechars = \"abcdefghijklmnopqrstuvwxyz\" \\","return \"(\" + x + \")\" if values: _keys = SQLQuery.join(values.keys(), ', ')",">>> q = SQLQuery([\"SELECT * FROM test WHERE name=\", SQLParam(\"joe\")]) >>> q <sql:","# eval mucks with it result = [] for live, chunk in _interpolate(string_):","order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses","safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj) if t is unicode: return obj elif","x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def","... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \"UPDATE foo SET age = 2,",">>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\xe1\\x88\\xb4') u'\\u1234' \"\"\" t = type(obj)","is None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def","%d\" % ( repr(self.text), self.pos) class SQLParam(object): \"\"\" Parameter in SQLQuery. >>> q","be inserted, each with the same set of keys. Returns the list of","* FROM foo WHERE x = \" + sqlquote('f'), _test=True) <sql: \"SELECT *","sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id':","`vars` is a `reparam`-style list to use instead of interpolating. >>> db =","\" % tablename + q(_keys) + ' VALUES ' + q(_values) else: sql_query","suffix=None, target=None): \"\"\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a,","SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for i, row","return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self, other): return","self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a separate query","the default, or to `False` if there isn't one. >>> db = DB(None,","%s, NOW())' >>> q.values() [2, 'bob'] \"\"\" def q(x): return \"(\" + x","def sqlquote(a): \"\"\" Ensures `a` is quoted properly for use in a SQL","where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self,","a SQL query. >>> 'WHERE x = ' + sqlquote(True) + ' AND","_test=True) <sql: \"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\"> \"\"\"","out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname is","For backward compatability, ignore escaping when the query looks already escaped if paramstyle","x and '%%' not in x: x = x.replace('%', '%%') s.append(x) return \"\".join(s)","SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test',","if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif","is None: svars = {} if not processed and not isinstance(sql_query, SQLQuery): sql_query","\"\".join(s) def values(self): \"\"\" Returns the values of the parameters used in the","0: break nextchar = sformat[dollar + 1] if nextchar == \"{\": chunks.append((0, sformat[pos:dollar]))","[] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items = [items]","<sql: \"SELECT * FROM foo WHERE x = 'f'\"> >>> db.query(\"SELECT * FROM","in values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT","svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \"\"\" Selects `what` from `tables`","its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \"'t'\" >>> sqlify(3) '3'","tstart, tend = match.regs[3] token = sformat[tstart:tend] if token == \"{\": level =","(basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def","created = NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \"\"\"","if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class","test WHERE name='joe'\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values()","isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\"\"\" Converts any","= [{\"name\": \"foo\", \"email\": \"<EMAIL>\"}, {\"name\": \"bar\", \"email\": \"<EMAIL>\"}] >>> db.multiple_insert('person', values=values, _test=True)","in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return","i, v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return","the ID if it's not the default, or to `False` if there isn't","= SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item in enumerate(items):","level + 1 elif token == \"}\": level = level - 1 chunks.append((1,","if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return self.query()","self.pos = pos def __str__(self): return \"unfinished expression in %s at char %d\"","'WHERE x = ' + sqlquote(True) + ' AND y = ' +","same set of keys. Returns the list of ids of the inserted rows.","out keys = values[0].keys() #@@ make sure all keys are valid # make","pos, level = dollar + 2, 1 while level: match, pos = matchorfail(sformat,","x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters","sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \"\"\" def __init__(self, v): self.v = v def __repr__(self): return","`dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id","'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix arguments can be","items=None): r\"\"\"Creates a new SQLQuery. >>> SQLQuery(\"x\") <sql: 'x'> >>> q = SQLQuery(['SELECT","= SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \"INSERT INTO %s DEFAULT VALUES\"","if isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items + self.items)","except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out def update(self,","q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \"INSERT INTO foo","**values): \"\"\" Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname` to","def sqlwhere(dictionary, grouping=' AND '): \"\"\" Converts a `dictionary` to an SQL WHERE","<sql: \"SELECT * FROM test WHERE name='joe'\"> >>> q.query() 'SELECT * FROM test","sql_query,processed=False, svars=None): \"\"\" Execute SQL query `sql_query` using dictionary `vars` to interpolate it.","x = $x\", vars=dict(x='f'), _test=True) <sql: \"SELECT * FROM foo WHERE x =","seqname=None, _test=False): \"\"\" Inserts multiple rows into `tablename`. The `values` must be a","SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM","SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other,","\\ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\"; chunks = [] pos = 0 while 1: dollar = sformat.find(\"$\",","= self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if","<sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\"foo.bar_id = bar.id\", limit=5, _test=True)","\"\"\" # because `1 == True and hash(1) == hash(True)` # we have"],"string":"[\n \"isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def\",\n \"def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part of the sql query. >>>\",\n \"and `offset`. Uses vars to interpolate. Otherwise, each clause can be a SQLQuery.\",\n \"r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT *\",\n \"match.regs[3] token = sformat[tstart:tend] if token[0] in \\\"([\\\": level = level + 1\",\n \"get concatenated to produce the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested\",\n \"chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar +\",\n \"NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars\",\n \"any given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4'\",\n \"pos + 1) elif sformat[pos] in \\\"([\\\": pos, level = pos + 1,\",\n \"'%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery()\",\n \"characters in the query # For backward compatability, ignore escaping when the query\",\n \"in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor =\",\n \">>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>>\",\n \"len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a\",\n \"{} if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return\",\n \"sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper SQL version >>> sqlify(None) 'NULL' >>>\",\n \"encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to unicode string. >>> safeunicode('hello') u'hello' >>>\",\n \"not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\"\",\n \"what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit),\",\n \"if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values):\",\n \"(ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def\",\n \"sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if\",\n \"items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items)\",\n \"_sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format string and returns\",\n \"\\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0 while 1: dollar = sformat.find(\\\"$\\\", pos)\",\n \"tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns current sequence ID.\",\n \"each row to be inserted, each with the same set of keys. Returns\",\n \"AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k + ' = ' + sqlparam(v)\",\n \"where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id\",\n \"[\\\"value\\\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle ==\",\n \">>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'>\",\n \"= val else: nout = reparam(val, svars) def xjoin(a, b): if a and\",\n \"+ sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) ==\",\n \"safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t is unicode:\",\n \"hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\"\",\n \"tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return\",\n \"def __radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self):\",\n \"y = ' + sqlquote(3) <sql: \\\"WHERE x = 't' AND y =\",\n \"target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return\",\n \"AND y = 3\\\"> >>> 'WHERE x = ' + sqlquote(True) + '\",\n \"USING ' + sqllist(using) if where: q += ' WHERE ' + where\",\n \"%s, name = %s, created = NOW() WHERE name = %s' >>> q.values()\",\n \"and b: return a + ' ' + b else: return a or\",\n \"'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other):\",\n \"= 'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars = {} where = self._where(where,\",\n \"return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst):\",\n \"__add__(self, other): return self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery()\",\n \"age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO foo (age, name, created) VALUES\",\n \"level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend]\",\n \"basestring): return lst else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2,\",\n \">>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b = %s' \\\"\\\"\\\"\",\n \"basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented\",\n \"provided, the items are appended to target instead of creating a new SQLQuery.\",\n \"% ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q =\",\n \"You can pass this sort of thing as a clause in any db\",\n \"not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some\",\n \"self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam\",\n \"text self.pos = pos def __str__(self): return \\\"unfinished expression in %s at char\",\n \"`vars`) and setting `values`. >>> db = DB(None, {}) >>> name = 'Joseph'\",\n \"row to be inserted, each with the same set of keys. Returns the\",\n \"('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def\",\n \"sql, val in sql_clauses if val is not None] qout = SQLQuery.join(clauses) if\",\n \"db.supports_multiple_insert = True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\":\",\n \"\\\"INSERT INTO %s DEFAULT VALUES\\\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False):\",\n \"def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else:\",\n \"_test=False, **values): \\\"\\\"\\\" Update `tables` with clause `where` (interpolated using `vars`) and setting\",\n \"== \\\".\\\" and \\\\ pos + 1 < len(sformat) and sformat[pos + 1]\",\n \"('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql,\",\n \"db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with\",\n \"SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return\",\n \"grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b':\",\n \"of dictioanries, one for each row to be inserted, each with the same\",\n \"name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for i in self.items if\",\n \"def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>'\",\n \"whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee)\",\n \"def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute\",\n \"match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \\\"([\\\": pos, level\",\n \"\\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks with it result = [] for\",\n \"this sort of thing as a clause in any db function. Otherwise, you\",\n \"= {} where = self._where(where, svars) query = ( \\\"UPDATE \\\" + sqllist(tables)\",\n \"return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount\",\n \"sqlquote([2, 3]) <sql: \\\"WHERE x = 't' AND y IN (2, 3)\\\"> \\\"\\\"\\\"\",\n \"target_items.append(prefix) for i, item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item,\",\n \"{}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql:\",\n \"True and hash(1) == hash(True)` # we have to do this the hard\",\n \"\\\"SELECT * FROM foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo\",\n \"where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with clause `where` (interpolated using `vars`)\",\n \"+ q(_keys) + ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return\",\n \"value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle ==\",\n \"\\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO\",\n \"$name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo SET\",\n \"return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query()\",\n \"`group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause can be\",\n \"`reparam`-style list to use instead of interpolating. >>> db = DB(None, {}) >>>\",\n \"If `processed=True`, `vars` is a `reparam`-style list to use instead of interpolating. >>>\",\n \"\\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos\",\n \"long)): if sql == 'WHERE': nout = 'id = ' + sqlquote(val) else:\",\n \"% (tablename, ', '.join(keys))) for i, row in enumerate(values): if i != 0:\",\n \"', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'>\",\n \">>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id =\",\n \"nout = val else: nout = reparam(val, svars) def xjoin(a, b): if a\",\n \"_values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \\\"INSERT INTO\",\n \"items = other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other):\",\n \"SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is\",\n \"q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except\",\n \"to be made to find # the id of the inserted row. q1,\",\n \"' ' + b else: return a or b return xjoin(sql, nout) def\",\n \"seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): #\",\n \"name=?' \\\"\\\"\\\" s = [] for x in self.items: if isinstance(x, SQLParam): x\",\n \"dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's\",\n \"self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM\",\n \"return \\\"INSERT INTO %s DEFAULT VALUES\\\" % table def multiple_insert(self, tablename, values, seqname=None,\",\n \"test WHERE name=?' \\\"\\\"\\\" s = [] for x in self.items: if isinstance(x,\",\n \"\\\"\\\"\\\" if svars is None: svars = {} where = self._where(where, svars) q\",\n \"+ sqlquote(True) + ' AND y = ' + sqlquote(3) <sql: \\\"WHERE x\",\n \"u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t is unicode: return obj elif t\",\n \"dollar = sformat.find(\\\"$\\\", pos) if dollar < 0: break nextchar = sformat[dollar +\",\n \"`sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v):\",\n \"`processed=True`, `vars` is a `reparam`-style list to use instead of interpolating. >>> db\",\n \"long)): where = \\\"id = \\\" + sqlparam(where) elif isinstance(where, (list, tuple)) and\",\n \"setting `values`. >>> db = DB(None, {}) >>> name = 'Joseph' >>> q\",\n \">>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM\",\n \"will call reparam for you. Internally, consists of `items`, which is a list\",\n \"DEFAULT VALUES\\\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple\",\n \"if _test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values):\",\n \"Deletes from `table` with clauses `where` and `using`. >>> db = DB(None, {})\",\n \"isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self\",\n \"age = %s, name = %s, created = NOW() WHERE name = %s'\",\n \"hash(1) == hash(True)` # we have to do this the hard way... if\",\n \"other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items\",\n \"db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO foo (age, name,\",\n \"sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b = %s' \\\"\\\"\\\" return\",\n \"b'> Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ',\",\n \"\\\"\\\"\\\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql:\",\n \"pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token\",\n \"\\\"(\\\" + x + \\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values\",\n \"paramstyle in ['format', 'pyformat']: if '%' in x and '%%' not in x:\",\n \"where = reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None, order=None,\",\n \"append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other] elif\",\n \"vars to interpolate. Otherwise, each clause can be a SQLQuery. >>> db =\",\n \"'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ')\",\n \"nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout =\",\n \"class SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>>\",\n \"clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\"\",\n \"i, item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items)\",\n \"self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where,\",\n \"Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses\",\n \"target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if i != 0:\",\n \"= 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo\",\n \"for use in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b'\",\n \"else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try:\",\n \"IN $s\\\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy()\",\n \"DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo', where='name = $name',\",\n \"dictionary. Returns an `SQLQuery` for the result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql:\",\n \"= 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id\",\n \"k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor\",\n \"itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to unicode\",\n \"= range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return\",\n \"+ q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT\",\n \"name='joe'\\\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\"\",\n \"obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def\",\n \"' AND y IN ' + sqlquote([2, 3]) <sql: \\\"WHERE x = 't'\",\n \"self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None):\",\n \"the id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor,\",\n \"id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2)\",\n \"return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return\",\n \"hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'):\",\n \"paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle\",\n \"and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else:\",\n \"( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT\",\n \"+ 1) elif sformat[pos] in \\\"([\\\": pos, level = pos + 1, 1\",\n \"= text self.pos = pos def __str__(self): return \\\"unfinished expression in %s at\",\n \"make sure all rows have same keys. for v in values: if v.keys()\",\n \"') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query()\",\n \"self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out\",\n \"for the result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>>\",\n \"sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'>\",\n \"in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item)\",\n \"'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return\",\n \"'<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`. >>>\",\n \"', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query =\",\n \"sqllist(tables) + \\\" SET \\\" + sqlwhere(values, ', ') + \\\" WHERE \\\"\",\n \"dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and a dictionary and\",\n \"or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog\",\n \"where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars)\",\n \"clauses `where` and `using`. >>> db = DB(None, {}) >>> name = 'Joe'\",\n \"clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id =\",\n \"BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val,\",\n \"if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the\",\n \"`SQLQuery` for the result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\">\",\n \"in a SQL query. >>> 'WHERE x = ' + sqlquote(True) + '\",\n \"'s IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks with it\",\n \"return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT VALUES\\\" % table\",\n \"', ') + \\\" WHERE \\\" + where) if _test: return query db_cursor\",\n \"seqname is False: return None else: return out keys = values[0].keys() #@@ make\",\n \"nout = reparam(val, svars) def xjoin(a, b): if a and b: return a\",\n \"is a list of strings and SQLParams, which get concatenated to produce the\",\n \"creating a new SQLQuery. \\\"\\\"\\\" if target is None: target = SQLQuery() target_items\",\n \"in \\\"([\\\": pos, level = pos + 1, 1 while level: match, pos\",\n \"( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order),\",\n \"token = sformat[tstart:tend] if token[0] in \\\"([\\\": level = level + 1 elif\",\n \"elif paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle,\",\n \"= 2, name = 'bob', created = NOW() WHERE name = 'Joseph'\\\"> >>>\",\n \"1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar\",\n \"= {} where = self._where(where, svars) q = 'DELETE FROM ' + table\",\n \"if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '):\",\n \"\\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person (name, email) VALUES ('foo',\",\n \"sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ',\",\n \"and returns a list of 2-tuples of the form (boolean, string) where boolean\",\n \"this the hard way... if obj is None: return 'NULL' elif obj is\",\n \"def _interpolate(sformat): \\\"\\\"\\\" Takes a format string and returns a list of 2-tuples\",\n \"elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items = [items] elif\",\n \"class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False,\",\n \"arguments for use in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a,\",\n \"interpolate it. If `processed=True`, `vars` is a `reparam`-style list to use instead of\",\n \"a or b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int,\",\n \"name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x):\",\n \"+ sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes\",\n \">>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t is unicode: return obj\",\n \"string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def\",\n \"db.query(\\\"SELECT * FROM foo WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT *\",\n \"xjoin(a, b): if a and b: return a + ' ' + b\",\n \"'numeric': return ':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']: return\",\n \"if there isn't one. >>> db = DB(None, {}) >>> q = db.insert('foo',\",\n \"pass this sort of thing as a clause in any db function. Otherwise,\",\n \"[other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items +\",\n \"name = 'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars = {} where =\",\n \"keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor = self._db_cursor()\",\n \"isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items else: return\",\n \"or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return\",\n \"are appended to target instead of creating a new SQLQuery. \\\"\\\"\\\" if target\",\n \"if svars is None: svars = {} if not processed and not isinstance(sql_query,\",\n \"for some databases, a separate query has to be made to find #\",\n \"string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\"\",\n \"created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo SET age = 2, name\",\n \"<sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars is\",\n \"1])) pos = dollar + 1 + (nextchar == \\\"$\\\") if pos <\",\n \"_ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos def\",\n \"$s\\\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() #\",\n \"and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return\",\n \"result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles (currently\",\n \"string) where boolean says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py>\",\n \"\\\"\\\"\\\" You can pass this sort of thing as a clause in any\",\n \"+= ' USING ' + sqllist(using) if where: q += ' WHERE '\",\n \"<sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=',\",\n \"can pass a dictionary to the keyword argument `vars` and the function will\",\n \"q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1,\",\n \"SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT VALUES\\\" %\",\n \"t is unicode: return obj elif t is str: return obj.decode(encoding) elif t\",\n \"FROM foo WHERE x = \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM\",\n \"If target argument is provided, the items are appended to target instead of\",\n \"name = 'bob', created = NOW() WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE\",\n \"utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\"\",\n \"return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2,\",\n \"return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format string and\",\n \"NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items =\",\n \"isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape\",\n \"b)'> If target argument is provided, the items are appended to target instead\",\n \"= dollar + 1 + (nextchar == \\\"$\\\") if pos < len(sformat): chunks.append((0,\",\n \"v in values.values()], ', ') sql_query = \\\"INSERT INTO %s \\\" % tablename\",\n \"= self._where(where, svars) query = ( \\\"UPDATE \\\" + sqllist(tables) + \\\" SET\",\n \"given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>>\",\n \"return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects\",\n \"has to be made to find # the id of the inserted row.\",\n \"= self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table,\",\n \"self.items = list(items.items) else: self.items = [items] # Take care of SQLLiterals for\",\n \"multiple rows into `tablename`. The `values` must be a list of dictioanries, one\",\n \">>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because `1\",\n \"'f'\\\"> \\\"\\\"\\\" if svars is None: svars = {} if not processed and\",\n \"isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj)\",\n \"pos + 1 < len(sformat) and sformat[pos + 1] in namechars: match, pos\",\n \"clause can be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True)\",\n \"return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into\",\n \"t = type(obj) if t is unicode: return obj elif t is str:\",\n \"%s at char %d\\\" % ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in\",\n \">>> 'WHERE x = ' + sqlquote(True) + ' AND y = '\",\n \">>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'),\",\n \"string and a dictionary and interpolates the string using values from the dictionary.\",\n \"of the inserted rows. Set `seqname` to the ID if it's not the\",\n \"isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] # Take care of\",\n \"== \\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping='\",\n \"* FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE\",\n \"[1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is None: self.items = []\",\n \"tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from\",\n \"'%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values of the parameters\",\n \"self.text = text self.pos = pos def __str__(self): return \\\"unfinished expression in %s\",\n \">>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix arguments\",\n \"isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id = ' +\",\n \"val is not None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout,\",\n \"sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out =\",\n \"sql_clauses(self, what, tables, where, group, order, limit, offset): return ( ('SELECT', what), ('FROM',\",\n \"sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v =\",\n \"used in the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE\",\n \"(list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery):\",\n \"_interpolate(sformat): \\\"\\\"\\\" Takes a format string and returns a list of 2-tuples of\",\n \"SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q\",\n \"inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query)\",\n \"_test=True) >>> q <sql: \\\"INSERT INTO foo (age, name, created) VALUES (2, 'bob',\",\n \"= matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token ==\",\n \"a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc')\",\n \"FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars is None: svars =\",\n \"where, group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where),\",\n \"return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items\",\n \"else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts\",\n \"if items is None: self.items = [] elif isinstance(items, list): self.items = items\",\n \"('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return [] if not self.supports_multiple_insert: out =\",\n \"sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename,\",\n \"else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to utf-8\",\n \"svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order,\",\n \"'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided,\",\n \"<sql: '(a, b)'> If target argument is provided, the items are appended to\",\n \"return sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query,\",\n \"* FROM foo WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM\",\n \"= SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \\\"INSERT INTO %s\",\n \"_test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars\",\n \"where: q += ' WHERE ' + where return q sqlproducer = SQLProducer()\",\n \"s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values of the parameters used\",\n \"target instead of creating a new SQLQuery. \\\"\\\"\\\" if target is None: target\",\n \"target_items = target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if i\",\n \">>> db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name =\",\n \"do this the hard way... if obj is None: return 'NULL' elif obj\",\n \"use in a SQL query. >>> 'WHERE x = ' + sqlquote(True) +\",\n \"sure all rows have same keys. for v in values: if v.keys() !=\",\n \"2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items = [] items.append('(') for i,\",\n \"\\\" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where =\",\n \"= 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b =\",\n \"x + \\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v)\",\n \">>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode):\",\n \"is None: svars = {} where = self._where(where, svars) q = 'DELETE FROM\",\n \"'DELETE FROM ' + table if using: q += ' USING ' +\",\n \"the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in sqlquote's docstring def\",\n \"db.query(\\\"SELECT * FROM foo WHERE x = \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT\",\n \"= SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql:\",\n \"out = None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where,\",\n \"+ self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery):\",\n \"[] items.append('(') for i, v in enumerate(values): if i != 0: items.append(', ')\",\n \"created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO foo (age, name, created) VALUES (2,\",\n \"1 elif token == \\\"}\\\": level = level - 1 chunks.append((1, sformat[dollar +\",\n \"(int, long)): where = \\\"id = \\\" + sqlparam(where) elif isinstance(where, (list, tuple))\",\n \"'WHERE x = ' + sqlquote(True) + ' AND y IN ' +\",\n \"type(obj) if t is unicode: return obj elif t is str: return obj.decode(encoding)\",\n \"(currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text,\",\n \"`a` is quoted properly for use in a SQL query. >>> 'WHERE x\",\n \"LIMIT 5'> \\\"\\\"\\\" if svars is None: svars = {} sql_clauses = self.sql_clauses(what,\",\n \"SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None):\",\n \"else: return out keys = values[0].keys() #@@ make sure all keys are valid\",\n \"return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to its\",\n \"repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments for use in something like a\",\n \"FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM\",\n \"form (boolean, string) where boolean says whether string should be evaled or not.\",\n \"\\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND\",\n \"@author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts\",\n \"= x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters in\",\n \"in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos\",\n \"foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\"\",\n \"True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>>\",\n \"default, or to `False` if there isn't one. >>> db = DB(None, {})\",\n \"1 + (nextchar == \\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks\",\n \"= db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO foo (age,\",\n \"db_cursor = self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname)\",\n \"= %s, created = NOW() WHERE name = %s' >>> q.values() [2, 'bob',\",\n \"q = 'DELETE FROM ' + table if using: q += ' USING\",\n \"name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT\",\n \"self._where(where, svars) q = 'DELETE FROM ' + table if using: q +=\",\n \"match = tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return match,\",\n \"other): return self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery() def\",\n \"3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id\",\n \"# automatically escape % characters in the query # For backward compatability, ignore\",\n \"* FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if svars\",\n \"a list of dictioanries, one for each row to be inserted, each with\",\n \"'pyformat']: if '%' in x and '%%' not in x: x = x.replace('%',\",\n \"= safestr(x) # automatically escape % characters in the query # For backward\",\n \"INTO %s DEFAULT VALUES\\\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\"\",\n \"UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other\",\n \"queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix\",\n \"keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES '\",\n \">>> name = 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2,\",\n \"not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if\",\n \"class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles (currently supported: qmark, numeric, format,\",\n \"argument is provided, the items are appended to target instead of creating a\",\n \"Update `tables` with clause `where` (interpolated using `vars`) and setting `values`. >>> db\",\n \"not the default, or to `False` if there isn't one. >>> db =\",\n \"* FROM test WHERE name=?' \\\"\\\"\\\" s = [] for x in self.items:\",\n \"from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to\",\n \"None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False,\",\n \"svars) def xjoin(a, b): if a and b: return a + ' '\",\n \"on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'):\",\n \"elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1)\",\n \"and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other):\",\n \"NOW() WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age = %s,\",\n \"thing as a clause in any db function. Otherwise, you can pass a\",\n \"= level + 1 elif token[0] in \\\")]\\\": level = level - 1\",\n \"SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles (currently supported: qmark,\",\n \"token[0] in \\\")]\\\": level = level - 1 else: break chunks.append((1, sformat[dollar +\",\n \"sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT VALUES\\\" % table def\",\n \"+ 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos =\",\n \"x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values\",\n \"+ 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 +\",\n \"2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\"\",\n \"function. Otherwise, you can pass a dictionary to the keyword argument `vars` and\",\n \"foo\\\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT * FROM foo WHERE\",\n \"x = safestr(x) # automatically escape % characters in the query # For\",\n \"limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if\",\n \"token == \\\"}\\\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos -\",\n \"SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape %\",\n \"SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where\",\n \"INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values:\",\n \">>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe']\",\n \"in namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \\\"([\\\":\",\n \"return \\\"'t'\\\" elif obj is False: return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime):\",\n \"_test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname`\",\n \"__iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return\",\n \"pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \\\"([\\\": level\",\n \"= 0 while 1: dollar = sformat.find(\\\"$\\\", pos) if dollar < 0: break\",\n \"isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility\",\n \"of ids of the inserted rows. Set `seqname` to the ID if it's\",\n \"isn't one. >>> db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2,\",\n \"\\\"\\\"\\\" def q(x): return \\\"(\\\" + x + \\\")\\\" if values: _keys =\",\n \"any db function. Otherwise, you can pass a dictionary to the keyword argument\",\n \"foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars = {}\",\n \"is unicode: return obj elif t is str: return obj.decode(encoding) elif t in\",\n \"xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)): where = \\\"id\",\n \"\\\" + where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if\",\n \"!= 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return\",\n \"self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None,\",\n \"svars): if isinstance(where, (int, long)): where = \\\"id = \\\" + sqlparam(where) elif\",\n \"chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary` to an SQL\",\n \"and '%%' not in x: x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def\",\n \"there isn't one. >>> db = DB(None, {}) >>> q = db.insert('foo', name='bob',\",\n \"isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values\",\n \"range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out\",\n \"'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring):\",\n \"in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and a dictionary\",\n \"__add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items =\",\n \"5'> \\\"\\\"\\\" if svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables,\",\n \"= [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] #\",\n \"a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\"\",\n \"\\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor = self._db_cursor() if seqname\",\n \"level + 1 elif token[0] in \\\")]\\\": level = level - 1 else:\",\n \"\\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates\",\n \"- 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar\",\n \"{}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id\",\n \"a clause in any db function. Otherwise, you can pass a dictionary to\",\n \"datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def\",\n \"AND y IN ' + sqlquote([2, 3]) <sql: \\\"WHERE x = 't' AND\",\n \"as a clause in any db function. Otherwise, you can pass a dictionary\",\n \"group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in\",\n \"def sqllist(lst): \\\"\\\"\\\" Converts the arguments for use in something like a WHERE\",\n \"clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val is\",\n \"def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self):\",\n \"target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item in\",\n \"isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where def select(self, tables,\",\n \"+ 1) while pos < len(sformat): if sformat[pos] == \\\".\\\" and \\\\ pos\",\n \"<sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's IN\",\n \"def sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper SQL version >>> sqlify(None) 'NULL'\",\n \"pos < len(sformat): if sformat[pos] == \\\".\\\" and \\\\ pos + 1 <\",\n \"\\\\ pos + 1 < len(sformat) and sformat[pos + 1] in namechars: match,\",\n \"class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos\",\n \"safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a\",\n \"# For backward compatability, ignore escaping when the query looks already escaped if\",\n \"SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()'))\",\n \"isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items + items) def\",\n \"group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP\",\n \"`what` from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars\",\n \"return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY',\",\n \"multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and\",\n \"('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql\",\n \"SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" #\",\n \"keys = values[0].keys() #@@ make sure all keys are valid # make sure\",\n \"'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2,\",\n \"isinstance(where, (int, long)): where = \\\"id = \\\" + sqlparam(where) elif isinstance(where, (list,\",\n \"you can pass a dictionary to the keyword argument `vars` and the function\",\n \"_test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\"\",\n \"DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True)\",\n \"Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")])\",\n \"in ['format', 'pyformat']: if '%' in x and '%%' not in x: x\",\n \"self.v = v def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates\",\n \"SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items =\",\n \"s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters in the query\",\n \"[] for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else:\",\n \"obj is True: return \\\"'t'\\\" elif obj is False: return \\\"'f'\\\" elif datetime\",\n \"for i, item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery):\",\n \"the result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s\",\n \"def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql == 'WHERE':\",\n \"return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)): where =\",\n \"FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT *\",\n \"elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] # Take care\",\n \"_keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ',\",\n \"group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables` with clauses `where`, `order`,\",\n \"'WHERE': nout = 'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif\",\n \"_sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items = [] items.append('(') for\",\n \"not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables,\",\n \"\\\"\\\"\\\" return [i.value for i in self.items if isinstance(i, SQLParam)] def join(items, sep='\",\n \"and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos + 1)\",\n \"list of 2-tuples of the form (boolean, string) where boolean says whether string\",\n \"boolean says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain,\",\n \"+ 1] in namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos]\",\n \"DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"},\",\n \"out = range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit()\",\n \"target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor = self._db_cursor() if seqname is\",\n \"in values.values()], ', ') sql_query = \\\"INSERT INTO %s \\\" % tablename +\",\n \"pass a dictionary to the keyword argument `vars` and the function will call\",\n \"3\\\"> >>> 'WHERE x = ' + sqlquote(True) + ' AND y IN\",\n \"test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>>\",\n \"def sql_clauses(self, what, tables, where, group, order, limit, offset): return ( ('SELECT', what),\",\n \"table): return \\\"INSERT INTO %s DEFAULT VALUES\\\" % table def multiple_insert(self, tablename, values,\",\n \"foo SET age = %s, name = %s, created = NOW() WHERE name\",\n \"x: x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the\",\n \"for sql, val in sql_clauses if val is not None] qout = SQLQuery.join(clauses)\",\n \">>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary\",\n \"__init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q =\",\n \"elif sformat[pos] in \\\"([\\\": pos, level = pos + 1, 1 while level:\",\n \"\\\"([\\\": level = level + 1 elif token[0] in \\\")]\\\": level = level\",\n \"get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return\",\n \"'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE\",\n \"SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i]\",\n \"= v def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a\",\n \"one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values =\",\n \"a format string and returns a list of 2-tuples of the form (boolean,\",\n \"not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog\",\n \"2, 3)'> \\\"\\\"\\\" items = [] items.append('(') for i, v in enumerate(values): if\",\n \"name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value): self.value =\",\n \"tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match\",\n \"% repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql:\",\n \"\\\"UPDATE foo SET age = 2, name = 'bob', created = NOW() WHERE\",\n \"= %s AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k + ' = '\",\n \"qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values`\",\n \"1 while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token\",\n \"cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3,\",\n \"items is None: self.items = [] elif isinstance(items, list): self.items = items elif\",\n \"must be a list of dictioanries, one for each row to be inserted,\",\n \"encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if\",\n \"test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for i in\",\n \"') sql_query = \\\"INSERT INTO %s \\\" % tablename + q(_keys) + '\",\n \"isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items + self.items) def\",\n \"') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly\",\n \"__init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return\",\n \"else: where = reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None,\",\n \"sqllist(using) if where: q += ' WHERE ' + where return q sqlproducer\",\n \"value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other,\",\n \"= matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in\",\n \"live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk)\",\n \"\\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query\",\n \"= self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars)\",\n \"argument `vars` and the function will call reparam for you. Internally, consists of\",\n \"foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE x =\",\n \"the form (boolean, string) where boolean says whether string should be evaled or\",\n \"b): if a and b: return a + ' ' + b else:\",\n \"offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql ==\",\n \"q(x): return \\\"(\\\" + x + \\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ',\",\n \"values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO\",\n \"= %s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is None: svars\",\n \"level = level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0,\",\n \"db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self,\",\n \"tend = match.regs[3] token = sformat[tstart:tend] if token == \\\"{\\\": level = level\",\n \"out+1) except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out def\",\n \"return '<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`.\",\n \"nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while\",\n \"tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is\",\n \"('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if\",\n \"b = %s' \\\"\\\"\\\" return SQLQuery.join([k + ' = ' + sqlparam(v) for\",\n \"('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return [] if not self.supports_multiple_insert:\",\n \"the list of ids of the inserted rows. Set `seqname` to the ID\",\n \"self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring):\",\n \"where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\"\",\n \"some databases, a separate query has to be made to find # the\",\n \"'a', 'b': 'b'}).query() 'a = %s AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k\",\n \"enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value):\",\n \"age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo SET age =\",\n \"return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self))\",\n \"of thing as a clause in any db function. Otherwise, you can pass\",\n \"one for each row to be inserted, each with the same set of\",\n \"v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\"\",\n \"elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars) def xjoin(a,\",\n \"set of keys. Returns the list of ids of the inserted rows. Set\",\n \"q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q\",\n \"{} where = self._where(where, svars) query = ( \\\"UPDATE \\\" + sqllist(tables) +\",\n \"None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self):\",\n \"return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts\",\n \"= [items] # Take care of SQLLiterals for i, item in enumerate(self.items): if\",\n \"return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return\",\n \"len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout\",\n \"= SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout\",\n \"is None: return 'NULL' elif obj is True: return \\\"'t'\\\" elif obj is\",\n \"* FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?'\",\n \"name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM test WHERE name='joe'\\\"> >>> q.query()\",\n \"['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self,\",\n \"def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using dictionary `vars` to\",\n \"+ sqlquote([2, 3]) <sql: \\\"WHERE x = 't' AND y IN (2, 3)\\\">\",\n \"return a or b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where,\",\n \"sqlwhere(values, ', ') + \\\" WHERE \\\" + where) if _test: return query\",\n \"v in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and a\",\n \"nout = 'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val,\",\n \"\\\"\\\"\\\" if svars is None: svars = {} where = self._where(where, svars) query\",\n \"'a = %s AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k + ' =\",\n \"of interpolating. >>> db = DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True)\",\n \"= bar.id LIMIT 5'> \\\"\\\"\\\" if svars is None: svars = {} sql_clauses\",\n \"Set `seqname` to the ID if it's not the default, or to `False`\",\n \"self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) #\",\n \"be made to find # the id of the inserted row. q1, q2\",\n \"%s, created = NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph']\",\n \"\\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj\",\n \"else: return NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\"\",\n \"and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')')\",\n \"'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age = %s, name = %s, created\",\n \"# tested in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>>\",\n \"level = level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar\",\n \"if where: q += ' WHERE ' + where return q sqlproducer =\",\n \">>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is None: self.items = [] elif\",\n \"= 'bob', created = NOW() WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo\",\n \"values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`. The `values` must be\",\n \"pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0]\",\n \"sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset))\",\n \"None: self.items = [] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam):\",\n \"in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\"\",\n \"= [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val is not\",\n \">>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v = v def __repr__(self):\",\n \"new SQLQuery. \\\"\\\"\\\" if target is None: target = SQLQuery() target_items = target.items\",\n \"and interpolates the string using values from the dictionary. Returns an `SQLQuery` for\",\n \"\\\"\\\"\\\" if svars is None: svars = {} if not processed and not\",\n \"\\\"\\\"\\\" Takes a string and a dictionary and interpolates the string using values\",\n \"+ ' AND y IN ' + sqlquote([2, 3]) <sql: \\\"WHERE x =\",\n \"sformat[pos] == \\\".\\\" and \\\\ pos + 1 < len(sformat) and sformat[pos +\",\n \"Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix\",\n \">>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql:\",\n \"vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo SET age = 2, name =\",\n \"def __add__(self, other): return self.sqlquery() + other def __radd__(self, other): return other +\",\n \"chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while level: match, pos\",\n \"(age, name, created) VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo (age,\",\n \"(name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return []\",\n \"\\\"INSERT INTO %s \\\" % tablename + q(_keys) + ' VALUES ' +\",\n \"iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to\",\n \"isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries.\",\n \"= bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id =\",\n \"dictionary and interpolates the string using values from the dictionary. Returns an `SQLQuery`\",\n \"= 'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list,\",\n \"[] for live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v))\",\n \"', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test\",\n \"elif paramstyle == 'numeric': return ':1' elif paramstyle is None or paramstyle in\",\n \"return self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery() def __str__(self):\",\n \"svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using dictionary `vars` to interpolate it. If\",\n \"in \\\"([\\\": level = level + 1 elif token[0] in \\\")]\\\": level =\",\n \"def update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with clause `where`\",\n \"= ( \\\"UPDATE \\\" + sqllist(tables) + \\\" SET \\\" + sqlwhere(values, ',\",\n \"SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self, other): return other\",\n \"to `False` if there isn't one. >>> db = DB(None, {}) >>> q\",\n \"item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def\",\n \"sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a\",\n \"\\\"\\\"\\\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match =\",\n \"__str__(self): return \\\"unfinished expression in %s at char %d\\\" % ( repr(self.text), self.pos)\",\n \"i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures\",\n \"return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def\",\n \"= \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0 while 1: dollar\",\n \"reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None,\",\n \">>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst else: return ', '.join(lst)\",\n \"SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT\",\n \"else: x = safestr(x) # automatically escape % characters in the query #\",\n \"(www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given\",\n \"seqname=seqname, _test=_test, **v) for v in values] if seqname is False: return None\",\n \"return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper SQL version >>>\",\n \"Take care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and\",\n \"class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM test\",\n \"3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND\",\n \"_where(self, where, svars): if isinstance(where, (int, long)): where = \\\"id = \\\" +\",\n \"+ ' AND y = ' + sqlquote(3) <sql: \\\"WHERE x = 't'\",\n \"2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val\",\n \"'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE\",\n \"items = [other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return\",\n \"the items are appended to target instead of creating a new SQLQuery. \\\"\\\"\\\"\",\n \"'3' \\\"\\\"\\\" # because `1 == True and hash(1) == hash(True)` # we\",\n \"repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT *\",\n \"= values[0].keys() #@@ make sure all keys are valid # make sure all\",\n \"v in values] if seqname is False: return None else: return out keys\",\n \"if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix:\",\n \"in enumerate(values): if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys],\",\n \"elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query())\",\n \"`seqname` to the ID if it's not the default, or to `False` if\",\n \"values] if seqname is False: return None else: return out keys = values[0].keys()\",\n \"`order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause can\",\n \"if svars is None: svars = {} where = self._where(where, svars) query =\",\n \"evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import\",\n \"\\\"}\\\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif\",\n \"level = pos + 1, 1 while level: match, pos = matchorfail(sformat, pos)\",\n \"Converts any given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2'\",\n \"= SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0],\",\n \"tablename + q(_keys) + ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename))\",\n \"if isinstance(where, (int, long)): where = \\\"id = \\\" + sqlparam(where) elif isinstance(where,\",\n \"__radd__(self, other): if isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items\",\n \"if sql == 'WHERE': nout = 'id = ' + sqlquote(val) else: nout\",\n \"of the parameters used in the sql query. >>> q = SQLQuery([\\\"SELECT *\",\n \"VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table):\",\n \"'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars = {} where = self._where(where, svars)\",\n \"\\\" + sqllist(tables) + \\\" SET \\\" + sqlwhere(values, ', ') + \\\"\",\n \"= 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'),\",\n \"y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery()\",\n \"%s AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k + ' = ' +\",\n \"SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for i in self.items if isinstance(i,\",\n \"' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self,\",\n \"val else: nout = reparam(val, svars) def xjoin(a, b): if a and b:\",\n \"result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db\",\n \"' + sqlquote(3) <sql: \\\"WHERE x = 't' AND y = 3\\\"> >>>\",\n \"def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`. The\",\n \"pos) if dollar < 0: break nextchar = sformat[dollar + 1] if nextchar\",\n \"('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT',\",\n \"val, svars) for sql, val in sql_clauses if val is not None] qout\",\n \"2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where,\",\n \"pass else: where = reparam(where, svars) return where def select(self, tables, svars=None, what='*',\",\n \"+ 2, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend =\",\n \"' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return\",\n \"if prefix: target_items.append(prefix) for i, item in enumerate(items): if i != 0: target_items.append(sep)\",\n \"def __str__(self): return \\\"unfinished expression in %s at char %d\\\" % ( repr(self.text),\",\n \"Returns the values of the parameters used in the sql query. >>> q\",\n \"offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`,\",\n \"\\\"\\\"\\\" Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname` to the\",\n \"order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int,\",\n \"db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar',\",\n \"level = dollar + 2, 1 while level: match, pos = matchorfail(sformat, pos)\",\n \"SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass this sort of thing as a\",\n \"[self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val is not None]\",\n \">>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\",\",\n \"self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items)\",\n \"what, tables, where, group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)),\",\n \"valid # make sure all rows have same keys. for v in values:\",\n \"\\\"\\\"\\\" Converts the arguments for use in something like a WHERE clause. >>>\",\n \"limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables` with clauses `where`, `order`, `group`,\",\n \"is not None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True)\",\n \"elif obj is True: return \\\"'t'\\\" elif obj is False: return \\\"'f'\\\" elif\",\n \"token == \\\"{\\\": level = level + 1 elif token == \\\"}\\\": level\",\n \"val in sql_clauses if val is not None] qout = SQLQuery.join(clauses) if _test:\",\n \"= value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle\",\n \"chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos < len(sformat):\",\n \"* FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE\",\n \"AND '): \\\"\\\"\\\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>>\",\n \"tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return match, match.end() namechars\",\n \"Internally, consists of `items`, which is a list of strings and SQLParams, which\",\n \"or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts\",\n \"sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group, order,\",\n \"self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes\",\n \"1) while pos < len(sformat): if sformat[pos] == \\\".\\\" and \\\\ pos +\",\n \"def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns current\",\n \"' + sqllist(using) if where: q += ' WHERE ' + where return\",\n \"limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT\",\n \"keyword argument `vars` and the function will call reparam for you. Internally, consists\",\n \"tested in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\")\",\n \"and hash(1) == hash(True)` # we have to do this the hard way...\",\n \"query = ( \\\"UPDATE \\\" + sqllist(tables) + \\\" SET \\\" + sqlwhere(values,\",\n \"!= 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a`\",\n \"each with the same set of keys. Returns the list of ids of\",\n \"== hash(True)` # we have to do this the hard way... if obj\",\n \"* FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM test\",\n \"len(sformat): if sformat[pos] == \\\".\\\" and \\\\ pos + 1 < len(sformat) and\",\n \"if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple):\",\n \"= ' + sqlquote(3) <sql: \\\"WHERE x = 't' AND y = 3\\\">\",\n \"else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar ==\",\n \"SQLParams, which get concatenated to produce the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"]\",\n \"is str: return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif\",\n \"from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text,\",\n \"SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \\\"INSERT INTO %s \\\"\",\n \"dict(s=[1, 2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval\",\n \"\\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person (name, email)\",\n \"unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given\",\n \"'b': 'b'}).query() 'a = %s AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k +\",\n \"dollar + 1 + (nextchar == \\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:]))\",\n \"the query part of the sql query. >>> q = SQLQuery([\\\"SELECT * FROM\",\n \"= DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo',\",\n \"created = NOW() WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age\",\n \"\\\"WHERE x = 't' AND y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list):\",\n \"= [other] elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items\",\n \"3]) <sql: \\\"WHERE x = 't' AND y IN (2, 3)\\\"> \\\"\\\"\\\" if\",\n \"elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj =\",\n \"\\\"unfinished expression in %s at char %d\\\" % ( repr(self.text), self.pos) class SQLParam(object):\",\n \"', ') <sql: 'a, b'> Optinally, prefix and suffix arguments can be provided.\",\n \"= True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}]\",\n \"level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar +\",\n \"+ sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0],\",\n \"'__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\"\",\n \"in x and '%%' not in x: x = x.replace('%', '%%') s.append(x) return\",\n \"where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE\",\n \"def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q\",\n \"FROM foo WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo\",\n \"(list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif\",\n \"q <sql: \\\"SELECT * FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM\",\n \"u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values):\",\n \"SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout =\",\n \"safestr(x) # automatically escape % characters in the query # For backward compatability,\",\n \"return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return\",\n \"sqlquote(True) + ' AND y = ' + sqlquote(3) <sql: \\\"WHERE x =\",\n \"repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\">\",\n \"i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\", target=sql_query,\",\n \"NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other)\",\n \"str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return\",\n \"each clause can be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo',\",\n \"sequence ID. Set `seqname` to the ID if it's not the default, or\",\n \"\\\"\\\"\\\" Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\",\",\n \"# because `1 == True and hash(1) == hash(True)` # we have to\",\n \"of `items`, which is a list of strings and SQLParams, which get concatenated\",\n \">>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if\",\n \"\\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj,\",\n \"+ b else: return a or b return xjoin(sql, nout) def _where(self, where,\",\n \"arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a,\",\n \"prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql:\",\n \"= 'f'\\\"> \\\"\\\"\\\" if svars is None: svars = {} if not processed\",\n \"\\\"SELECT * FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars is None:\",\n \"sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor = self._db_cursor() if\",\n \"+ items) def __radd__(self, other): if isinstance(other, basestring): items = [other] else: return\",\n \"foo WHERE x = \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo\",\n \"x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters in the\",\n \"def xjoin(a, b): if a and b: return a + ' ' +\",\n \"2-tuples of the form (boolean, string) where boolean says whether string should be\",\n \"\\\"\\\"\\\" Inserts multiple rows into `tablename`. The `values` must be a list of\",\n \"UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat)\",\n \"', ') sql_query = \\\"INSERT INTO %s \\\" % tablename + q(_keys) +\",\n \"_interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '')\",\n \"val, svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id\",\n \"+ 1 + (nextchar == \\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return\",\n \"seqname) if isinstance(sql_query, tuple): # for some databases, a separate query has to\",\n \"target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x)\",\n \"self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif\",\n \"unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t\",\n \"paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self])\",\n \"age = 2, name = 'bob', created = NOW() WHERE name = 'Joseph'\\\">\",\n \"sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for\",\n \"in %s at char %d\\\" % ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter\",\n \"<sql: \\\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if\",\n \"using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with clauses `where` and `using`. >>>\",\n \"SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM\",\n \">>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO\",\n \">>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT\",\n \"what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables` with\",\n \"+ \\\" WHERE \\\" + where) if _test: return query db_cursor = self._db_cursor()\",\n \"part of the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE\",\n \"'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3},\",\n \"of creating a new SQLQuery. \\\"\\\"\\\" if target is None: target = SQLQuery()\",\n \"if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit()\",\n \"') <sql: 'a, b'> Optinally, prefix and suffix arguments can be provided. >>>\",\n \"query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in sqlquote's docstring def __init__(self, items=None):\",\n \"\\\"\\\"\\\" if not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname,\",\n \"\\\"WHERE x = 't' AND y = 3\\\"> >>> 'WHERE x = '\",\n \"table if using: q += ' USING ' + sqllist(using) if where: q\",\n \"1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos\",\n \"SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False,\",\n \"<sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v = v\",\n \"self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return\",\n \"q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out\",\n \"the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor,\",\n \"and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery):\",\n \"= SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self, tablename, seqname=None,\",\n \"1) elif sformat[pos] in \\\"([\\\": pos, level = pos + 1, 1 while\",\n \"pos, level = pos + 1, 1 while level: match, pos = matchorfail(sformat,\",\n \"to produce the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in sqlquote's\",\n \"_test=False): \\\"\\\"\\\" Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`, and\",\n \"SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value\",\n \"if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query\",\n \"svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with clause `where` (interpolated using `vars`) and\",\n \"\\\" + sqlwhere(values, ', ') + \\\" WHERE \\\" + where) if _test:\",\n \"elif isinstance(other, SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items + items)\",\n \"db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE name =\",\n \"else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s\",\n \"db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\\\"name\\\": \\\"foo\\\",\",\n \"INTO foo (age, name, created) VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO\",\n \"have to do this the hard way... if obj is None: return 'NULL'\",\n \"automatically escape % characters in the query # For backward compatability, ignore escaping\",\n \"+ 1])) pos = dollar + 1 + (nextchar == \\\"$\\\") if pos\",\n \"'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s,\",\n \"AND y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else: return\",\n \"char %d\\\" % ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>>\",\n \"(interpolated using `vars`) and setting `values`. >>> db = DB(None, {}) >>> name\",\n \"x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(),\",\n \"sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT\",\n \"= db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None if not\",\n \"elif token == \\\"}\\\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos\",\n \"encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to utf-8 encoded string. >>> safestr('hello') 'hello'\",\n \"which is a list of strings and SQLParams, which get concatenated to produce\",\n \"pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token == \\\"{\\\": level\",\n \"offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if val\",\n \"while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token =\",\n \"self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins\",\n \"query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values()\",\n \"to interpolate. Otherwise, each clause can be a SQLQuery. >>> db = DB(None,\",\n \"def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT VALUES\\\" % table def multiple_insert(self,\",\n \"\\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT\",\n \"'NULL' elif obj is True: return \\\"'t'\\\" elif obj is False: return \\\"'f'\\\"\",\n \"''' Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def\",\n \"it result = [] for live, chunk in _interpolate(string_): if live: v =\",\n \"interpolate. Otherwise, each clause can be a SQLQuery. >>> db = DB(None, {})\",\n \"SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>>\",\n \"'t'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\"\",\n \"(%s) VALUES ' % (tablename, ', '.join(keys))) for i, row in enumerate(values): if\",\n \"{}) >>> name = 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob',\",\n \"self.items = [] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items\",\n \"**v) for v in values] if seqname is False: return None else: return\",\n \"', '.join(keys))) for i, row in enumerate(values): if i != 0: sql_query.append(\\\", \\\")\",\n \"matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos)\",\n \"(2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat):\",\n \"< len(sformat) and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos\",\n \"return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class\",\n \"db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None if not self.ctx.transactions:\",\n \"unicode: return obj elif t is str: return obj.decode(encoding) elif t in [int,\",\n \"_test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`. The `values` must be a list\",\n \"Takes a format string and returns a list of 2-tuples of the form\",\n \"sql_query = \\\"INSERT INTO %s \\\" % tablename + q(_keys) + ' VALUES\",\n \"if obj is None: return 'NULL' elif obj is True: return \\\"'t'\\\" elif\",\n \">>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value): self.value = value\",\n \"= obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments for use in\",\n \"'t' AND y = 3\\\"> >>> 'WHERE x = ' + sqlquote(True) +\",\n \"tables, where, group, order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE',\",\n \"lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any\",\n \"def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric':\",\n \"values.values()], ', ') sql_query = \\\"INSERT INTO %s \\\" % tablename + q(_keys)\",\n \"SQLQuery): self.items = list(items.items) else: self.items = [items] # Take care of SQLLiterals\",\n \"to `False` if there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert\",\n \"\\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person (name, email) VALUES\",\n \"is True: return \\\"'t'\\\" elif obj is False: return \\\"'f'\\\" elif datetime and\",\n \"_test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5,\",\n \"dictionary = dictionary.copy() # eval mucks with it result = [] for live,\",\n \"= [] for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x))\",\n \"`where` and `using`. >>> db = DB(None, {}) >>> name = 'Joe' >>>\",\n \"{}) >>> db.supports_multiple_insert = True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\":\",\n \"0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\")\",\n \"lst else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql:\",\n \"= %s, name = %s, created = NOW() WHERE name = %s' >>>\",\n \"'\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str):\",\n \"elif isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif\",\n \"to target instead of creating a new SQLQuery. \\\"\\\"\\\" if target is None:\",\n \"Converts the arguments for use in something like a WHERE clause. >>> sqllist(['a',\",\n \"backward compatability, ignore escaping when the query looks already escaped if paramstyle in\",\n \"= tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return match, match.end()\",\n \"def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to unicode string. >>> safeunicode('hello')\",\n \"[2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is None: svars = {} where =\",\n \"\\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because `1 == True and hash(1) ==\",\n \">>> db.query(\\\"SELECT * FROM foo WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT\",\n \"NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" + x +\",\n \"< 0: break nextchar = sformat[dollar + 1] if nextchar == \\\"{\\\": chunks.append((0,\",\n \"+ sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\"\",\n \"query part of the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test\",\n \"dollar + 1) while pos < len(sformat): if sformat[pos] == \\\".\\\" and \\\\\",\n \"[other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other,\",\n \">>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__\",\n \"be a list of dictioanries, one for each row to be inserted, each\",\n \">>> q <sql: \\\"SELECT * FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT *\",\n \"suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return self.query() %\",\n \"keys are valid # make sure all rows have same keys. for v\",\n \"def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam =\",\n \"suffix=\\\")\\\") if _test: return sql_query db_cursor = self._db_cursor() if seqname is not False:\",\n \"2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b = %s'\",\n \"elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj,\",\n \"x = ' + sqlquote(True) + ' AND y = ' + sqlquote(3)\",\n \">>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT\",\n \"isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments\",\n \"q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is None: svars = {} where\",\n \"= $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\">\",\n \"`False` if there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert =\",\n \"q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ =\",\n \">>> db.supports_multiple_insert = True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\",\",\n \"if dollar < 0: break nextchar = sformat[dollar + 1] if nextchar ==\",\n \"chunks = [] pos = 0 while 1: dollar = sformat.find(\\\"$\\\", pos) if\",\n \"the query # For backward compatability, ignore escaping when the query looks already\",\n \"* FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items\",\n \"of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else:\",\n \"return [i.value for i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ',\",\n \"dollar + 2, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend\",\n \"INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob']\",\n \"name = 'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2, ...\",\n \"_str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError):\",\n \"' AND y = ' + sqlquote(3) <sql: \\\"WHERE x = 't' AND\",\n \"pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\"\",\n \"to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3)\",\n \"not None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def\",\n \"svars is None: svars = {} where = self._where(where, svars) query = (\",\n \"if sformat[pos] == \\\".\\\" and \\\\ pos + 1 < len(sformat) and sformat[pos\",\n \"%s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is None: svars =\",\n \">>> q.query() 'UPDATE foo SET age = %s, name = %s, created =\",\n \"sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos + 1) elif\",\n \"target is None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for\",\n \"2, name = 'bob', created = NOW() WHERE name = 'Joseph'\\\"> >>> q.query()\",\n \">>> q <sql: \\\"UPDATE foo SET age = 2, name = 'bob', created\",\n \"if it's not the default, or to `False` if there isn't one. >>>\",\n \"str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper SQL version >>> sqlify(None)\",\n \"q.values() ['joe'] \\\"\\\"\\\" return [i.value for i in self.items if isinstance(i, SQLParam)] def\",\n \"# make sure all rows have same keys. for v in values: if\",\n \"db paramstyles (currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def\",\n \"v def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database.\",\n \"_test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'>\",\n \"paramstyle == 'numeric': return ':1' elif paramstyle is None or paramstyle in ['format',\",\n \"rows. Set `seqname` to the ID if it's not the default, or to\",\n \"+ ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def\",\n \"\\\"'t'\\\" elif obj is False: return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return\",\n \"Execute SQL query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars`\",\n \"[self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname is False: return\",\n \">>> q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT\",\n \"name = %s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is None:\",\n \"table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with clauses `where` and\",\n \"\\\")]\\\": level = level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else:\",\n \"__repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass\",\n \"q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" + x + \\\")\\\" if\",\n \"values of the parameters used in the sql query. >>> q = SQLQuery([\\\"SELECT\",\n \"len(sformat) and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat, pos +\",\n \"\\\"\\\"\\\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2,\",\n \"sqlquote(3) <sql: \\\"WHERE x = 't' AND y = 3\\\"> >>> 'WHERE x\",\n \"self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update\",\n \"if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join =\",\n \"return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table`\",\n \"+ ' = ' + sqlparam(v) for k, v in dictionary.items()], grouping) def\",\n \"WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age = %s, name\",\n \"svars) query = ( \\\"UPDATE \\\" + sqllist(tables) + \\\" SET \\\" +\",\n \"DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT * FROM foo'>\",\n \">>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person',\",\n \"where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables` with clauses\",\n \"sql query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>>\",\n \"`tables` with clause `where` (interpolated using `vars`) and setting `values`. >>> db =\",\n \"== 'WHERE': nout = 'id = ' + sqlquote(val) else: nout = SQLQuery(val)\",\n \"else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring,\",\n \"limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group),\",\n \"q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\"\",\n \"# backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars)\",\n \"q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO\",\n \"db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>>\",\n \"created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return\",\n \"' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'>\",\n \"return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You can\",\n \"try: return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return\",\n \"'UPDATE foo SET age = %s, name = %s, created = NOW() WHERE\",\n \"i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix)\",\n \"str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to utf-8 encoded string.\",\n \"sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary` to an SQL WHERE clause\",\n \"chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return\",\n \"str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object):\",\n \"if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return\",\n \"\\\"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT\",\n \"reparam(val, svars) def xjoin(a, b): if a and b: return a + '\",\n \"match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0 while\",\n \"WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars is None: svars = {} if\",\n \"self.query(qout, processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`.\",\n \"def __radd__(self, other): if isinstance(other, basestring): items = [other] else: return NotImplemented return\",\n \"order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables` with clauses `where`,\",\n \"else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format string and returns a\",\n \"domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text,\",\n \"return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode):\",\n \"2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks with it result = []\",\n \"= SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass this sort of thing as\",\n \"None: svars = {} if not processed and not isinstance(sql_query, SQLQuery): sql_query =\",\n \"is None: svars = {} where = self._where(where, svars) query = ( \\\"UPDATE\",\n \"for live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else:\",\n \"'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE x = \\\" + sqlquote('f'), _test=True)\",\n \"', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ')\",\n \"== 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout =\",\n \"(age, name, created) VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def\",\n \"from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self,\",\n \"namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0 while 1:\",\n \"else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring):\",\n \"namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \\\"([\\\": pos,\",\n \"for i, row in enumerate(values): if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for\",\n \"= [] for live, chunk in _interpolate(string_): if live: v = eval(chunk, dictionary)\",\n \"i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None):\",\n \"interpolates the string using values from the dictionary. Returns an `SQLQuery` for the\",\n \"\\\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not\",\n \">>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE\",\n \"SQLQuery.join([k + ' = ' + sqlparam(v) for k, v in dictionary.items()], grouping)\",\n \"def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items\",\n \"except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str())\",\n \">>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument\",\n \"x = 'f'\\\"> \\\"\\\"\\\" if svars is None: svars = {} if not\",\n \"return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos =\",\n \"`values` must be a list of dictioanries, one for each row to be\",\n \"self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from\",\n \"= %s' \\\"\\\"\\\" return SQLQuery.join([k + ' = ' + sqlparam(v) for k,\",\n \"{\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person (name,\",\n \"3)'> \\\"\\\"\\\" items = [] items.append('(') for i, v in enumerate(values): if i\",\n \"= [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname is False:\",\n \"elif token[0] in \\\")]\\\": level = level - 1 else: break chunks.append((1, sformat[dollar\",\n \"return lst else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3])\",\n \"= tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None:\",\n \"to the keyword argument `vars` and the function will call reparam for you.\",\n \"\\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally,\",\n \"to use instead of interpolating. >>> db = DB(None, {}) >>> db.query(\\\"SELECT *\",\n \"\\\"{\\\": level = level + 1 elif token == \\\"}\\\": level = level\",\n \"join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'],\",\n \"using values from the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\\\"s\",\n \"qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self, tablename,\",\n \"= item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items\",\n \"elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj,\",\n \"items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly for use\",\n \"version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because\",\n \"target join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x\",\n \"return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to utf-8 encoded\",\n \"multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`. The `values`\",\n \"def q(x): return \\\"(\\\" + x + \\\")\\\" if values: _keys = SQLQuery.join(values.keys(),\",\n \"FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s',\",\n \"rows have same keys. for v in values: if v.keys() != keys: raise\",\n \"(nextchar == \\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary,\",\n \"separate query has to be made to find # the id of the\",\n \"bar.id LIMIT 5'> \\\"\\\"\\\" if svars is None: svars = {} sql_clauses =\",\n \"`obj` to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>>\",\n \"obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr,\",\n \"# Take care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam)\",\n \"+ sqllist(tables) + \\\" SET \\\" + sqlwhere(values, ', ') + \\\" WHERE\",\n \">>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items = [] items.append('(')\",\n \"returns a list of 2-tuples of the form (boolean, string) where boolean says\",\n \"order, limit, offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY',\",\n \"tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \\\"([\\\": level =\",\n \"to be inserted, each with the same set of keys. Returns the list\",\n \"x = 't' AND y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return\",\n \"name = %s, created = NOW() WHERE name = %s' >>> q.values() [2,\",\n \"Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match\",\n \"while 1: dollar = sformat.find(\\\"$\\\", pos) if dollar < 0: break nextchar =\",\n \"match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0\",\n \"(1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks with it result =\",\n \"u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t\",\n \"reparam for you. Internally, consists of `items`, which is a list of strings\",\n \"into `tablename`. The `values` must be a list of dictioanries, one for each\",\n \"_test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT * FROM foo WHERE x\",\n \"'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ',\",\n \"# we have to do this the hard way... if obj is None:\",\n \"in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql:\",\n \"items = [other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other):\",\n \"a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql:\",\n \"< len(sformat): if sformat[pos] == \\\".\\\" and \\\\ pos + 1 < len(sformat)\",\n \"== 'numeric': return ':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']:\",\n \"to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id =\",\n \"list): self.items = items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery):\",\n \"0 while 1: dollar = sformat.find(\\\"$\\\", pos) if dollar < 0: break nextchar\",\n \"', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided, the items\",\n \"if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a\",\n \"pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return \\\"unfinished expression\",\n \"other): return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param:\",\n \"items) def __radd__(self, other): if isinstance(other, basestring): items = [other] else: return NotImplemented\",\n \"WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is\",\n \"should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from\",\n \"\\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0 while 1: dollar =\",\n \"clause `where` (interpolated using `vars`) and setting `values`. >>> db = DB(None, {})\",\n \"== \\\"}\\\": level = level - 1 chunks.append((1, sformat[dollar + 2:pos - 1]))\",\n \"an `SQLQuery` for the result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s =\",\n \"foo SET age = 2, name = 'bob', created = NOW() WHERE name\",\n \"= $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2]))\",\n \"* FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM test WHERE name=%s'\",\n \"something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a'\",\n \"+ 1 elif token[0] in \\\")]\\\": level = level - 1 else: break\",\n \"+ 1 < len(sformat) and sformat[pos + 1] in namechars: match, pos =\",\n \"itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper\",\n \"return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values of the parameters used in\",\n \"can be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql:\",\n \"b: return a + ' ' + b else: return a or b\",\n \"level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars:\",\n \"with it result = [] for live, chunk in _interpolate(string_): if live: v\",\n \"ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename,\",\n \"all rows have same keys. for v in values: if v.keys() != keys:\",\n \"isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else:\",\n \"unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments for\",\n \"looks already escaped if paramstyle in ['format', 'pyformat']: if '%' in x and\",\n \"IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def\",\n \"pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos\",\n \"for x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str())\",\n \"current sequence ID. Set `seqname` to the ID if it's not the default,\",\n \"WHERE name=?' \\\"\\\"\\\" s = [] for x in self.items: if isinstance(x, SQLParam):\",\n \"self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql:\",\n \"pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text self.pos =\",\n \"= 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE x = \\\" + sqlquote('f'),\",\n \"FROM test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self,\",\n \"+ other def __radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value)\",\n \"'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle is None\",\n \"an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3\",\n \"return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query\",\n \"obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments for use\",\n \"in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self):\",\n \"db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar\",\n \"None: svars = {} where = self._where(where, svars) q = 'DELETE FROM '\",\n \"_test=_test, **v) for v in values] if seqname is False: return None else:\",\n \"else: self.items = [items] # Take care of SQLLiterals for i, item in\",\n \"sformat[pos] in \\\"([\\\": pos, level = pos + 1, 1 while level: match,\",\n \"the hard way... if obj is None: return 'NULL' elif obj is True:\",\n \"inserted, each with the same set of keys. Returns the list of ids\",\n \"\\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while level: match,\",\n \"['format', 'pyformat']: if '%' in x and '%%' not in x: x =\",\n \"safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to unicode string. >>> safeunicode('hello') u'hello'\",\n \"= None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None,\",\n \"name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO foo (age, name, created)\",\n \"= [] pos = 0 while 1: dollar = sformat.find(\\\"$\\\", pos) if dollar\",\n \"= ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and\",\n \"svars = {} where = self._where(where, svars) q = 'DELETE FROM ' +\",\n \"_test=True) <sql: \\\"DELETE FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars is\",\n \"bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return\",\n \"sformat.find(\\\"$\\\", pos) if dollar < 0: break nextchar = sformat[dollar + 1] if\",\n \"[int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj)\",\n \"q += ' USING ' + sqllist(using) if where: q += ' WHERE\",\n \"self.sqlquery() + other def __radd__(self, other): return other + self.sqlquery() def __str__(self): return\",\n \"q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'>\",\n \"SET age = 2, name = 'bob', created = NOW() WHERE name =\",\n \"'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst else: return ',\",\n \"SQL query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars` is\",\n \"%s \\\" % tablename + q(_keys) + ' VALUES ' + q(_values) else:\",\n \"function will call reparam for you. Internally, consists of `items`, which is a\",\n \"or b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)):\",\n \"def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to utf-8 encoded string. >>>\",\n \"q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT *\",\n \"the string using values from the dictionary. Returns an `SQLQuery` for the result.\",\n \"'.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\"\",\n \"chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match,\",\n \"None: return 'NULL' elif obj is True: return \\\"'t'\\\" elif obj is False:\",\n \"\\\"\\\"\\\" if isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\"\",\n \"in the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\",\",\n \"given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4')\",\n \"in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def\",\n \"target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self):\",\n \"`tablename`. The `values` must be a list of dictioanries, one for each row\",\n \"svars) q = 'DELETE FROM ' + table if using: q += '\",\n \"FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s'\",\n \"= DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(),\",\n \"= SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for i,\",\n \"<http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog = tokenprog\",\n \"= 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql:\",\n \"'SELECT * FROM test WHERE name=?' \\\"\\\"\\\" s = [] for x in\",\n \"Returns the query part of the sql query. >>> q = SQLQuery([\\\"SELECT *\",\n \"1 elif token[0] in \\\")]\\\": level = level - 1 else: break chunks.append((1,\",\n \"db = DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT *\",\n \"(int, long)): if sql == 'WHERE': nout = 'id = ' + sqlquote(val)\",\n \"SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly for use in a\",\n \"i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v\",\n \"return \\\"unfinished expression in %s at char %d\\\" % ( repr(self.text), self.pos) class\",\n \"and `using`. >>> db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo',\",\n \"v in values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query =\",\n \"if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value)\",\n \"if not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test,\",\n \"in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def\",\n \"pos def __str__(self): return \\\"unfinished expression in %s at char %d\\\" % (\",\n \"= \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x =\",\n \"3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\"\",\n \"limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses if\",\n \"return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj)\",\n \"at char %d\\\" % ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery.\",\n \"':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s' raise\",\n \"if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'):\",\n \"from the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\\\"s = $s\\\",\",\n \"SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1])\",\n \"bar WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if svars is None: svars\",\n \"in the query # For backward compatability, ignore escaping when the query looks\",\n \"+ x + \\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values =\",\n \"= dictionary.copy() # eval mucks with it result = [] for live, chunk\",\n \"numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text\",\n \"= dollar + 2, 1 while level: match, pos = matchorfail(sformat, pos) tstart,\",\n \"paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def\",\n \"obj elif t is str: return obj.decode(encoding) elif t in [int, float, bool]:\",\n \"= [\\\"value\\\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle\",\n \"+ self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value)\",\n \"foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if svars is None:\",\n \"= sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0]\",\n \"_test=False): \\\"\\\"\\\" Deletes from `table` with clauses `where` and `using`. >>> db =\",\n \"% characters in the query # For backward compatability, ignore escaping when the\",\n \"pos = dollar + 1 + (nextchar == \\\"$\\\") if pos < len(sformat):\",\n \"ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return \\\"unfinished expression in\",\n \"TypeError): return self.query() def __str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self):\",\n \"sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2:\",\n \"{}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT\",\n \"test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1])\",\n \"Returns current sequence ID. Set `seqname` to the ID if it's not the\",\n \"= SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT *\",\n \"safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to utf-8 encoded string. >>> safestr('hello')\",\n \"list to use instead of interpolating. >>> db = DB(None, {}) >>> db.query(\\\"SELECT\",\n \"be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize\",\n \"is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for\",\n \"\\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test:\",\n \"def join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a',\",\n \"WHERE x = \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE\",\n \"return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly for use in\",\n \"and a dictionary and interpolates the string using values from the dictionary. Returns\",\n \"sql == 'WHERE': nout = 'id = ' + sqlquote(val) else: nout =\",\n \"isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where,\",\n \"\\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'):\",\n \"\\\"\\\"\\\" Execute SQL query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`,\",\n \"isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): #\",\n \"where boolean says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public\",\n \"db function. Otherwise, you can pass a dictionary to the keyword argument `vars`\",\n \"return sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset): return (\",\n \"unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError):\",\n \"+ 1, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend =\",\n \"sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self, other):\",\n \"= ' + sqlquote(True) + ' AND y IN ' + sqlquote([2, 3])\",\n \"for i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None,\",\n \"for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string\",\n \"not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v)\",\n \"\\\"\\\"\\\" s = [] for x in self.items: if isinstance(x, SQLParam): x =\",\n \"if there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True\",\n \"other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other,\",\n \"'.join(keys))) for i, row in enumerate(values): if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k])\",\n \"\\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v\",\n \"docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>>\",\n \"WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark')\",\n \"= matchorfail(sformat, pos + 1) elif sformat[pos] in \\\"([\\\": pos, level = pos\",\n \"way... if obj is None: return 'NULL' elif obj is True: return \\\"'t'\\\"\",\n \"`vars` and the function will call reparam for you. Internally, consists of `items`,\",\n \"raise _ItplError(text, pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks =\",\n \"produce the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in sqlquote's docstring\",\n \"else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper SQL version\",\n \"a separate query has to be made to find # the id of\",\n \"grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and a dictionary and interpolates\",\n \"call reparam for you. Internally, consists of `items`, which is a list of\",\n \"vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars\",\n \">>> db = DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo',\",\n \"'t' AND y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else:\",\n \"and the function will call reparam for you. Internally, consists of `items`, which\",\n \"if token[0] in \\\"([\\\": level = level + 1 elif token[0] in \\\")]\\\":\",\n \"ID if it's not the default, or to `False` if there isn't one.\",\n \"tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`. The `values` must\",\n \"sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out\",\n \"= ' + sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary):\",\n \"the query looks already escaped if paramstyle in ['format', 'pyformat']: if '%' in\",\n \"svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses\",\n \"return out def update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with\",\n \"tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos)\",\n \"SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other,\",\n \"return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles (currently supported:\",\n \"paramstyle=None): \\\"\\\"\\\" Returns the query part of the sql query. >>> q =\",\n \"== 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where =\",\n \"item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items =\",\n \"SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE\",\n \"isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1,\",\n \"when the query looks already escaped if paramstyle in ['format', 'pyformat']: if '%'\",\n \"# the id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor, q1)\",\n \"FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM test WHERE\",\n \"'a, b'> Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'],\",\n \"class SQLQuery(object): \\\"\\\"\\\" You can pass this sort of thing as a clause\",\n \"* FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT *\",\n \"x = ' + sqlquote(True) + ' AND y IN ' + sqlquote([2,\",\n \"match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if\",\n \"(tablename, ', '.join(keys))) for i, row in enumerate(values): if i != 0: sql_query.append(\\\",\",\n \"else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos =\",\n \"return obj elif t is str: return obj.decode(encoding) elif t in [int, float,\",\n \"paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle\",\n \"% table def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into\",\n \"vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT\",\n \"<sql: \\\"DELETE FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars is None:\",\n \"quoted properly for use in a SQL query. >>> 'WHERE x = '\",\n \"= reparam(where, svars) return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None,\",\n \"SET \\\" + sqlwhere(values, ', ') + \\\" WHERE \\\" + where) if\",\n \"in any db function. Otherwise, you can pass a dictionary to the keyword\",\n \"'Joseph' >>> q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(),\",\n \"b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst\",\n \"are valid # make sure all rows have same keys. for v in\",\n \"q(_keys) + ' VALUES ' + q(_values) else: sql_query = SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query\",\n \"is None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i,\",\n \"foo WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE\",\n \"where, svars): if isinstance(where, (int, long)): where = \\\"id = \\\" + sqlparam(where)\",\n \"safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if\",\n \"if a and b: return a + ' ' + b else: return\",\n \"sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary` to\",\n \"unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to\",\n \"already escaped if paramstyle in ['format', 'pyformat']: if '%' in x and '%%'\",\n \"if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None, suffix=None, target=None): \\\"\\\"\\\" Joins multiple\",\n \"2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2,\",\n \"using dictionary `vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style list\",\n \"object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234'\",\n \"use instead of interpolating. >>> db = DB(None, {}) >>> db.query(\\\"SELECT * FROM\",\n \"= SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM\",\n \"None else: return out keys = values[0].keys() #@@ make sure all keys are\",\n \"eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for\",\n \"appended to target instead of creating a new SQLQuery. \\\"\\\"\\\" if target is\",\n \"is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit,\",\n \">>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'>\",\n \"for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class\",\n \"__init__(self, v): self.v = v def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def\",\n \"paramstyle='pyformat'): if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return ':1'\",\n \"if svars is None: svars = {} where = self._where(where, svars) q =\",\n \"%s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string from `sqlquote`. >>> sqlquote('NOW()')\",\n \"_test: return sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query =\",\n \"% repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass this sort\",\n \"IN ' + sqlquote([2, 3]) <sql: \\\"WHERE x = 't' AND y IN\",\n \"sort of thing as a clause in any db function. Otherwise, you can\",\n \"new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ',\",\n \"= {} if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars)\",\n \"q <sql: \\\"UPDATE foo SET age = 2, name = 'bob', created =\",\n \"unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def\",\n \"self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part\",\n \"says whether string should be evaled or not. from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping\",\n \">>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst else:\",\n \"2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a':\",\n \"def values(self): \\\"\\\"\\\" Returns the values of the parameters used in the sql\",\n \"a + ' ' + b else: return a or b return xjoin(sql,\",\n \"where = self._where(where, svars) q = 'DELETE FROM ' + table if using:\",\n \"\\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using dictionary\",\n \"WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE x = \\\"\",\n \"break nextchar = sformat[dollar + 1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos,\",\n \"in SQLQuery. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>>\",\n \"is provided, the items are appended to target instead of creating a new\",\n \"and setting `values`. >>> db = DB(None, {}) >>> name = 'Joseph' >>>\",\n \"0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is\",\n \"2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat,\",\n \"with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise,\",\n \"list of dictioanries, one for each row to be inserted, each with the\",\n \"pos = 0 while 1: dollar = sformat.find(\\\"$\\\", pos) if dollar < 0:\",\n \"= 3\\\"> >>> 'WHERE x = ' + sqlquote(True) + ' AND y\",\n \"% tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self):\",\n \"False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases,\",\n \"== True and hash(1) == hash(True)` # we have to do this the\",\n \"isinstance(sql_query, tuple): # for some databases, a separate query has to be made\",\n \"def _where(self, where, svars): if isinstance(where, (int, long)): where = \\\"id = \\\"\",\n \"db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>>\",\n \"svars is None: svars = {} if not processed and not isinstance(sql_query, SQLQuery):\",\n \">>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE name\",\n \"Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime def safeunicode(obj,\",\n \"safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj,\",\n \"return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments for use in something like\",\n \"object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2)\",\n \"sure all keys are valid # make sure all rows have same keys.\",\n \"not self.ctx.transactions: self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\"\",\n \"== 'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle is\",\n \"__str__(self): return str(self.value) def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam\",\n \"\\\"\\\"\\\" Ensures `a` is quoted properly for use in a SQL query. >>>\",\n \"= \\\"id = \\\" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) ==\",\n \"\\\"([\\\": pos, level = pos + 1, 1 while level: match, pos =\",\n \"q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT\",\n \"the keyword argument `vars` and the function will call reparam for you. Internally,\",\n \"_get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT VALUES\\\" % table def multiple_insert(self, tablename,\",\n \"* FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars is None: svars\",\n \"other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>' %\",\n \"\\\"id = \\\" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2:\",\n \"which get concatenated to produce the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] #\",\n \"Otherwise, each clause can be a SQLQuery. >>> db = DB(None, {}) >>>\",\n \"qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self)\",\n \"db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name = $name',\",\n \"query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part of the sql query. >>> q\",\n \"= NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if\",\n \"SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT\",\n \"2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id =\",\n \"in x: x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns\",\n \"while pos < len(sformat): if sformat[pos] == \\\".\\\" and \\\\ pos + 1\",\n \"not in x: x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\"\",\n \"prefix: target_items.append(prefix) for i, item in enumerate(items): if i != 0: target_items.append(sep) if\",\n \"FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \\\"\\\"\\\"\",\n \"y IN ' + sqlquote([2, 3]) <sql: \\\"WHERE x = 't' AND y\",\n \"svars) for sql, val in sql_clauses if val is not None] qout =\",\n \"properly for use in a SQL query. >>> 'WHERE x = ' +\",\n \"foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if svars is None: svars = {}\",\n \"<reponame>handsome3163/H2Dgame-Firefly<gh_stars>100-1000 #coding:utf8 ''' Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import\",\n \"True: return \\\"'t'\\\" elif obj is False: return \\\"'f'\\\" elif datetime and isinstance(obj,\",\n \"safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class\",\n \"`offset`. Uses vars to interpolate. Otherwise, each clause can be a SQLQuery. >>>\",\n \"pos + 1, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend\",\n \"'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a',\",\n \"ID. Set `seqname` to the ID if it's not the default, or to\",\n \"obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or\",\n \"matchorfail(sformat, pos + 1) elif sformat[pos] in \\\"([\\\": pos, level = pos +\",\n \"values(self): \\\"\\\"\\\" Returns the values of the parameters used in the sql query.\",\n \"def delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with clauses\",\n \"into `tablename`. Returns current sequence ID. Set `seqname` to the ID if it's\",\n \"v): self.v = v def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self):\",\n \"= type(obj) if t is unicode: return obj elif t is str: return\",\n \"level = level + 1 elif token == \\\"}\\\": level = level -\",\n \"return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object\",\n \"<sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=',\",\n \"v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items)\",\n \"'') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles (currently supported: qmark, numeric,\",\n \"`False` if there isn't one. >>> db = DB(None, {}) >>> q =\",\n \"WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>>\",\n \"\\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\"\",\n \"offset): return ( ('SELECT', what), ('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER\",\n \"['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value): self.value = value def get_marker(self,\",\n \"paramstyles (currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self,\",\n \"other): if isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items +\",\n \"we have to do this the hard way... if obj is None: return\",\n \"'(1, 2, 3)'> \\\"\\\"\\\" items = [] items.append('(') for i, v in enumerate(values):\",\n \"SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group,\",\n \"%s (%s) VALUES ' % (tablename, ', '.join(keys))) for i, row in enumerate(values):\",\n \"using: q += ' USING ' + sqllist(using) if where: q += '\",\n \"SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self):\",\n \"if match is None: raise _ItplError(text, pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\"\",\n \"database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using\",\n \"%s' \\\"\\\"\\\" return SQLQuery.join([k + ' = ' + sqlparam(v) for k, v\",\n \"= 'DELETE FROM ' + table if using: q += ' USING '\",\n \"FROM test WHERE name=?' \\\"\\\"\\\" s = [] for x in self.items: if\",\n \"enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a):\",\n \"') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query = \\\"INSERT\",\n \"DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql:\",\n \"len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part of the sql query.\",\n \"tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql,\",\n \"if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\",\",\n \"`sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style\",\n \"= ' + sqlquote(True) + ' AND y = ' + sqlquote(3) <sql:\",\n \"NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the\",\n \"table def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`.\",\n \"def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self,\",\n \"if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically\",\n \"staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()]) except\",\n \"be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If\",\n \"if val is not None] qout = SQLQuery.join(clauses) if _test: return qout return\",\n \"'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)])\",\n \"enumerate(values): if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\",\",\n \"= DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\":\",\n \"WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for i in self.items\",\n \"FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for i\",\n \"elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else:\",\n \">>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for i in self.items if isinstance(i, SQLParam)]\",\n \"#@@ make sure all keys are valid # make sure all rows have\",\n \"'id = ' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple))\",\n \">>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because `1 == True and\",\n \"pos): match = tokenprog.match(text, pos) if match is None: raise _ItplError(text, pos) return\",\n \"k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and\",\n \"FROM ' + table if using: q += ' USING ' + sqllist(using)\",\n \"'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE\",\n \"items = [] items.append('(') for i, v in enumerate(values): if i != 0:\",\n \"query. >>> 'WHERE x = ' + sqlquote(True) + ' AND y =\",\n \"items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted\",\n \"string using values from the dictionary. Returns an `SQLQuery` for the result. >>>\",\n \"rows into `tablename`. The `values` must be a list of dictioanries, one for\",\n \">>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return\",\n \"self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query,\",\n \"ignore escaping when the query looks already escaped if paramstyle in ['format', 'pyformat']:\",\n \"matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos] == \\\".\\\" and\",\n \"= pos def __str__(self): return \\\"unfinished expression in %s at char %d\\\" %\",\n \"SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT * FROM test\",\n \">>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif\",\n \"using `vars`) and setting `values`. >>> db = DB(None, {}) >>> name =\",\n \"delete(self, table, where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with clauses `where`\",\n \"sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst else: return\",\n \"for each row to be inserted, each with the same set of keys.\",\n \"<sql: \\\"WHERE x = 't' AND y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a,\",\n \"one. >>> db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'),\",\n \"sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos < len(sformat): if\",\n \"and \\\\ pos + 1 < len(sformat) and sformat[pos + 1] in namechars:\",\n \"+ 1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar +\",\n \"foo (age, name, created) VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo\",\n \"dictionary.copy() # eval mucks with it result = [] for live, chunk in\",\n \">>> db = DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True)\",\n \"_test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return\",\n \"row in enumerate(values): if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in\",\n \"nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while\",\n \"to interpolate it. If `processed=True`, `vars` is a `reparam`-style list to use instead\",\n \"def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral:\",\n \"query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None,\",\n \"basestring): items = [other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self,\",\n \"'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v = v def __repr__(self): return self.v class\",\n \"= match.regs[3] token = sformat[tstart:tend] if token[0] in \\\"([\\\": level = level +\",\n \"<sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v = v def __repr__(self): return self.v\",\n \"' + sqlquote(True) + ' AND y IN ' + sqlquote([2, 3]) <sql:\",\n \"sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val,\",\n \"SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self,\",\n \"datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8')\",\n \"return a + ' ' + b else: return a or b return\",\n \"for k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query\",\n \"a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query`\",\n \"('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if\",\n \"obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\" Converts the arguments for use in something\",\n \"sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format string and returns a list of\",\n \"dictionary): \\\"\\\"\\\" Takes a string and a dictionary and interpolates the string using\",\n \"= level - 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in\",\n \"value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return '?'\",\n \"' + sqlquote(val) else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val)\",\n \"__unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\"\",\n \"a `reparam`-style list to use instead of interpolating. >>> db = DB(None, {})\",\n \"i, row in enumerate(values): if i != 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k\",\n \"expression in %s at char %d\\\" % ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\"\",\n \"try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None\",\n \"matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \\\"([\\\":\",\n \"= SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return\",\n \"repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass this sort of\",\n \"1 < len(sformat) and sformat[pos + 1] in namechars: match, pos = matchorfail(sformat,\",\n \"is quoted properly for use in a SQL query. >>> 'WHERE x =\",\n \"nextchar = sformat[dollar + 1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level\",\n \"'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if\",\n \"all keys are valid # make sure all rows have same keys. for\",\n \"= other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self, other): if\",\n \"insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns current sequence\",\n \"svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id =\",\n \"items are appended to target instead of creating a new SQLQuery. \\\"\\\"\\\" if\",\n \"__repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string from\",\n \"FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars =\",\n \"test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is None:\",\n \"'(a, b)'> If target argument is provided, the items are appended to target\",\n \"= \\\" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where\",\n \"be a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT\",\n \"matchorfail(sformat, pos) tstart, tend = match.regs[3] token = sformat[tstart:tend] if token == \\\"{\\\":\",\n \"0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target\",\n \"__radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return\",\n \"update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with clause `where` (interpolated\",\n \"name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age = %s, name =\",\n \"import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to unicode string.\",\n \"clause in any db function. Otherwise, you can pass a dictionary to the\",\n \"'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" + x + \\\")\\\" if values: _keys\",\n \"def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark':\",\n \"nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else:\",\n \"Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out def update(self, tables,\",\n \"where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE name = 'Joe'\\\">\",\n \"$name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if\",\n \"SQLParam('joe')]) >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT *\",\n \"isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items,\",\n \"in \\\")]\\\": level = level - 1 else: break chunks.append((1, sformat[dollar + 1:pos]))\",\n \"join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x in\",\n \"= list(items.items) else: self.items = [items] # Take care of SQLLiterals for i,\",\n \"WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM test WHERE name='joe'\\\"> >>>\",\n \"raise UnknownParamstyle, paramstyle def sqlquery(self): return SQLQuery([self]) def __add__(self, other): return self.sqlquery() +\",\n \"can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'>\",\n \"\\\" WHERE \\\" + where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor,\",\n \"= 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s\",\n \"DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'],\",\n \"or to `False` if there isn't one. >>> db = DB(None, {}) >>>\",\n \"Inserts multiple rows into `tablename`. The `values` must be a list of dictioanries,\",\n \"a list of strings and SQLParams, which get concatenated to produce the actual\",\n \"= DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT * FROM\",\n \"for v in values] if seqname is False: return None else: return out\",\n \"self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError, TypeError): return self.query() def\",\n \"INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for i, row in\",\n \"else: nout = SQLQuery(val) elif isinstance(val, (list, tuple)) and len(val) == 2: nout\",\n \"1, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3]\",\n \"isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join)\",\n \"test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \\\"\\\"\\\" s\",\n \"q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>>\",\n \"return 'NULL' elif obj is True: return \\\"'t'\\\" elif obj is False: return\",\n \"`vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style list to use\",\n \"Converts any given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234')\",\n \"elif obj is False: return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat())\",\n \"return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif\",\n \"match.regs[3] token = sformat[tstart:tend] if token == \\\"{\\\": level = level + 1\",\n \"datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to unicode string. >>>\",\n \"= 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's IN (1, 2)'>\",\n \"x = 't' AND y = 3\\\"> >>> 'WHERE x = ' +\",\n \"sformat[dollar + 1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar\",\n \"token[0] in \\\"([\\\": level = level + 1 elif token[0] in \\\")]\\\": level\",\n \"VALUES (%s, %s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\"\",\n \"_test=True) >>> q <sql: \\\"UPDATE foo SET age = 2, name = 'bob',\",\n \"= 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age = %s, name = %s,\",\n \"r\\\"\\\"\\\" Converts any given object to utf-8 encoded string. >>> safestr('hello') 'hello' >>>\",\n \"1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar +\",\n \"reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset):\",\n \"'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding)\",\n \"<sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM\",\n \"[i.value for i in self.items if isinstance(i, SQLParam)] def join(items, sep=' ', prefix=None,\",\n \"def __len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part of\",\n \"sql, val, svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout =\",\n \"select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what`\",\n \"any given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>>\",\n \"\\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's IN (1,\",\n \"obj is None: return 'NULL' elif obj is True: return \\\"'t'\\\" elif obj\",\n \"if t is unicode: return obj elif t is str: return obj.decode(encoding) elif\",\n \"s = [] for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle)\",\n \"format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text =\",\n \">>> q <sql: \\\"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\\\">\",\n \"(%s, %s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" +\",\n \"sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because `1 ==\",\n \"if token == \\\"{\\\": level = level + 1 elif token == \\\"}\\\":\",\n \"it. If `processed=True`, `vars` is a `reparam`-style list to use instead of interpolating.\",\n \"SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join = staticmethod(join) def\",\n \"dollar < 0: break nextchar = sformat[dollar + 1] if nextchar == \\\"{\\\":\",\n \"\\\"\\\"\\\" Returns the query part of the sql query. >>> q = SQLQuery([\\\"SELECT\",\n \"<sql: \\\"UPDATE foo SET age = 2, name = 'bob', created = NOW()\",\n \"is None: raise _ItplError(text, pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\";\",\n \">>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM foo,\",\n \"instead of creating a new SQLQuery. \\\"\\\"\\\" if target is None: target =\",\n \"for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] =\",\n \"\\\"\\\"\\\" Takes a format string and returns a list of 2-tuples of the\",\n \"3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items = [] items.append('(') for i, v\",\n \"items.append('(') for i, v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v))\",\n \"list of strings and SQLParams, which get concatenated to produce the actual query.\",\n \">>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', '\",\n \"['joe'] \\\"\\\"\\\" return [i.value for i in self.items if isinstance(i, SQLParam)] def join(items,\",\n \"def __add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items\",\n \"instead of interpolating. >>> db = DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\",\",\n \"the same set of keys. Returns the list of ids of the inserted\",\n \"`items`, which is a list of strings and SQLParams, which get concatenated to\",\n \"[items] # Take care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item,\",\n \"\\\" SET \\\" + sqlwhere(values, ', ') + \\\" WHERE \\\" + where)\",\n \"SQLQuery): items = other.items else: return NotImplemented return SQLQuery(self.items + items) def __radd__(self,\",\n \"hard way... if obj is None: return 'NULL' elif obj is True: return\",\n \"self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery):\",\n \"= NOW() WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET age =\",\n \"Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ',\",\n \"IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks with it result\",\n \"'Joseph'] \\\"\\\"\\\" if svars is None: svars = {} where = self._where(where, svars)\",\n \"'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because `1 == True\",\n \"dictionary to the keyword argument `vars` and the function will call reparam for\",\n \">>> 'WHERE x = ' + sqlquote(True) + ' AND y IN '\",\n \"' + sqlquote([2, 3]) <sql: \\\"WHERE x = 't' AND y IN (2,\",\n \"SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is None: self.items = [] elif isinstance(items,\",\n \"FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is\",\n \"'%' in x and '%%' not in x: x = x.replace('%', '%%') s.append(x)\",\n \"for x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x\",\n \"match, pos = matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos]\",\n \"if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\"\",\n \"u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t is unicode: return\",\n \"{} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql,\",\n \"find # the id of the inserted row. q1, q2 = sql_query self._db_execute(db_cursor,\",\n \"cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a = %s AND b\",\n \"* FROM test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def\",\n \"row. q1, q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try:\",\n \"sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar == \\\"$\\\") if\",\n \"keys. for v in values: if v.keys() != keys: raise ValueError, 'Bad data'\",\n \"you. Internally, consists of `items`, which is a list of strings and SQLParams,\",\n \"of the form (boolean, string) where boolean says whether string should be evaled\",\n \"strings and SQLParams, which get concatenated to produce the actual query. \\\"\\\"\\\" __slots__\",\n \"`limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause can be a\",\n \"FROM foo\\\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT * FROM foo\",\n \"r\\\"\\\"\\\" Converts any given object to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2)\",\n \"return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__')\",\n \"Returns an `SQLQuery` for the result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s\",\n \"tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None: raise\",\n \"x in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x =\",\n \"of keys. Returns the list of ids of the inserted rows. Set `seqname`\",\n \"sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass this sort of thing\",\n \"care of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value,\",\n \"float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else:\",\n \"<sql: \\\"WHERE x = 't' AND y = 3\\\"> >>> 'WHERE x =\",\n \"elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj)\",\n \"len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where\",\n \"= SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ')\",\n \"pos = matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos] ==\",\n \"is False: return None else: return out keys = values[0].keys() #@@ make sure\",\n \"$s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql:\",\n \"name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \\\"\\\"\\\" s = []\",\n \"sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> \\\"\\\"\\\" if\",\n \"sqlparam(where) elif isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1])\",\n \"'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts\",\n \"backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars) def\",\n \"return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding)\",\n \"'1'> \\\"\\\"\\\" if items is None: self.items = [] elif isinstance(items, list): self.items\",\n \"query `sql_query` using dictionary `vars` to interpolate it. If `processed=True`, `vars` is a\",\n \"self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out =\",\n \"* FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT\",\n \"from <http://lfw.org/python/Itpl.py> (public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog =\",\n \"= staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()])\",\n \"not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def\",\n \"name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo SET age\",\n \"use in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>>\",\n \"return None else: return out keys = values[0].keys() #@@ make sure all keys\",\n \"= level - 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar\",\n \"'?' elif paramstyle == 'numeric': return ':1' elif paramstyle is None or paramstyle\",\n \"WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars = {} where\",\n \"target argument is provided, the items are appended to target instead of creating\",\n \"for v in values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query\",\n \"FROM foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE x\",\n \"def reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and a dictionary and interpolates the\",\n \"tuple): # for some databases, a separate query has to be made to\",\n \"where, using=None, svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with clauses `where` and `using`.\",\n \"SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix arguments can\",\n \"\\\"\\\"\\\" Update `tables` with clause `where` (interpolated using `vars`) and setting `values`. >>>\",\n \"the values of the parameters used in the sql query. >>> q =\",\n \"'<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename,\",\n \"person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return\",\n \"result = [] for live, chunk in _interpolate(string_): if live: v = eval(chunk,\",\n \"pos = matchorfail(sformat, pos + 1) elif sformat[pos] in \\\"([\\\": pos, level =\",\n \"WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe']\",\n \"- 1 else: break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1]))\",\n \"'2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif\",\n \"values[0].keys() #@@ make sure all keys are valid # make sure all rows\",\n \"= reparam(val, svars) def xjoin(a, b): if a and b: return a +\",\n \"def append(self, value): self.items.append(value) def __add__(self, other): if isinstance(other, basestring): items = [other]\",\n \"if isinstance(other, basestring): items = [other] elif isinstance(other, SQLQuery): items = other.items else:\",\n \"{} where = self._where(where, svars) q = 'DELETE FROM ' + table if\",\n \"<sql: \\\"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\\\"> >>> q.query()\",\n \"return '?' elif paramstyle == 'numeric': return ':1' elif paramstyle is None or\",\n \"SQLQuery): pass else: where = reparam(where, svars) return where def select(self, tables, svars=None,\",\n \">>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>> values = [{\\\"name\\\":\",\n \"of SQLLiterals for i, item in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral):\",\n \"concatenated to produce the actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in\",\n \"') + \\\" WHERE \\\" + where) if _test: return query db_cursor =\",\n \"(public domain, Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog = tokenprog def\",\n \"`values` into `tablename`. Returns current sequence ID. Set `seqname` to the ID if\",\n \"__len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part of the\",\n \"suffix=')') <sql: '(a, b)'> If target argument is provided, the items are appended\",\n \"\\\"\\\"\\\" raised for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\"\",\n \"svars = {} where = self._where(where, svars) query = ( \\\"UPDATE \\\" +\",\n \"+ \\\" SET \\\" + sqlwhere(values, ', ') + \\\" WHERE \\\" +\",\n \"= [\\\"items\\\"] # tested in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new\",\n \"target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if suffix: target_items.append(suffix) return target join\",\n \"= [] items.append('(') for i, v in enumerate(values): if i != 0: items.append(',\",\n \"q <sql: \\\"INSERT INTO foo (age, name, created) VALUES (2, 'bob', NOW())\\\"> >>>\",\n \"and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self, what,\",\n \"`tables` with clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate.\",\n \"self.items = [items] # Take care of SQLLiterals for i, item in enumerate(self.items):\",\n \"and SQLParams, which get concatenated to produce the actual query. \\\"\\\"\\\" __slots__ =\",\n \"tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) # backwards-compatibility elif isinstance(val,\",\n \"[items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items] # Take\",\n \"if v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s\",\n \"pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text, pos): ValueError.__init__(self) self.text = text\",\n \"\\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\">\",\n \"< len(sformat): chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts\",\n \"'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE\",\n \"obj is False: return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else:\",\n \"in values] if seqname is False: return None else: return out keys =\",\n \"isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format\",\n \"' + sqlquote(True) + ' AND y = ' + sqlquote(3) <sql: \\\"WHERE\",\n \"1] in namechars: match, pos = matchorfail(sformat, pos + 1) elif sformat[pos] in\",\n \"\\\"UPDATE \\\" + sqllist(tables) + \\\" SET \\\" + sqlwhere(values, ', ') +\",\n \"'bob', 'Joseph'] \\\"\\\"\\\" if svars is None: svars = {} where = self._where(where,\",\n \"live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception):\",\n \"sqlquote(True) + ' AND y IN ' + sqlquote([2, 3]) <sql: \\\"WHERE x\",\n \"query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query()\",\n \"with clauses `where` and `using`. >>> db = DB(None, {}) >>> name =\",\n \"if isinstance(lst, basestring): return lst else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>>\",\n \"False: return None else: return out keys = values[0].keys() #@@ make sure all\",\n \"<sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT * FROM foo WHERE x =\",\n \">>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>>\",\n \"self.items = items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items\",\n \"(boolean, string) where boolean says whether string should be evaled or not. from\",\n \"with the same set of keys. Returns the list of ids of the\",\n \">>> sqlify(3) '3' \\\"\\\"\\\" # because `1 == True and hash(1) == hash(True)`\",\n \"sformat[pos:dollar])) pos, level = dollar + 2, 1 while level: match, pos =\",\n \"reparam(string_, dictionary): \\\"\\\"\\\" Takes a string and a dictionary and interpolates the string\",\n \"`values`. >>> db = DB(None, {}) >>> name = 'Joseph' >>> q =\",\n \"name = 'Joe' >>> db.delete('foo', where='name = $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM\",\n \"_ItplError(text, pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = []\",\n \"= $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo\",\n \"<sql: '1'> \\\"\\\"\\\" if items is None: self.items = [] elif isinstance(items, list):\",\n \"the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')])\",\n \"db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT *\",\n \"y = 3\\\"> >>> 'WHERE x = ' + sqlquote(True) + ' AND\",\n \"1: dollar = sformat.find(\\\"$\\\", pos) if dollar < 0: break nextchar = sformat[dollar\",\n \"<sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks with\",\n \">>> q = db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True)\",\n \"- 1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0,\",\n \"in _interpolate(string_): if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result,\",\n \"t is str: return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj)\",\n \"sformat[tstart:tend] if token == \\\"{\\\": level = level + 1 elif token ==\",\n \"to unicode string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\"\",\n \"tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass\",\n \"'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql:\",\n \"hash(True)` # we have to do this the hard way... if obj is\",\n \"namechars: chunks.append((0, sformat[pos:dollar])) match, pos = matchorfail(sformat, dollar + 1) while pos <\",\n \"FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if svars is\",\n \"isinstance(val, SQLQuery): nout = val else: nout = reparam(val, svars) def xjoin(a, b):\",\n \"supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass class _ItplError(ValueError): def __init__(self, text, pos):\",\n \"if target is None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix)\",\n \"query has to be made to find # the id of the inserted\",\n \"other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented\",\n \"to utf-8 encoded string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2'\",\n \"a string and a dictionary and interpolates the string using values from the\",\n \"foo'> >>> db.query(\\\"SELECT * FROM foo WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql:\",\n \"NOW())\\\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())'\",\n \"isinstance(where, (list, tuple)) and len(where) == 2: where = SQLQuery(where[0], where[1]) elif isinstance(where,\",\n \"dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported\",\n \"query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using dictionary `vars` to interpolate\",\n \"result. >>> reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN\",\n \"' % (tablename, ', '.join(keys))) for i, row in enumerate(values): if i !=\",\n \"sqlify(3) '3' \\\"\\\"\\\" # because `1 == True and hash(1) == hash(True)` #\",\n \"import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object to\",\n \"if svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group,\",\n \"unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj elif hasattr(obj, 'next'): # iterator\",\n \"db.select('foo', _test=True) <sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\",\",\n \"+ ' ' + b else: return a or b return xjoin(sql, nout)\",\n \"\\\".\\\" and \\\\ pos + 1 < len(sformat) and sformat[pos + 1] in\",\n \"x=1'> >>> q.query(), q.values() ('SELECT * FROM test WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1))\",\n \"'SELECT * FROM test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"]\",\n \"svars = {} if not processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query,\",\n \"SET age = %s, name = %s, created = NOW() WHERE name =\",\n \"SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items = [other] else:\",\n \"of 2-tuples of the form (boolean, string) where boolean says whether string should\",\n \"{}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT * FROM foo'> >>>\",\n \"= 't' AND y = 3\\\"> >>> 'WHERE x = ' + sqlquote(True)\",\n \"db = DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo', where='name\",\n \"sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly for use in a SQL query.\",\n \"= [] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items =\",\n \"b else: return a or b return xjoin(sql, nout) def _where(self, where, svars):\",\n \"q.query() 'INSERT INTO foo (age, name, created) VALUES (%s, %s, NOW())' >>> q.values()\",\n \"+ sqlquote(True) + ' AND y IN ' + sqlquote([2, 3]) <sql: \\\"WHERE\",\n \"* FROM foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE\",\n \"break chunks.append((1, sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar\",\n \"[\\\"items\\\"] # tested in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a new SQLQuery.\",\n \"= items elif isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items =\",\n \"_sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items =\",\n \"+ table if using: q += ' USING ' + sqllist(using) if where:\",\n \"suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql:\",\n \"else: return ', '.join(lst) def _sqllist(values): \\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1,\",\n \"' + table if using: q += ' USING ' + sqllist(using) if\",\n \"q.query() 'UPDATE foo SET age = %s, name = %s, created = NOW()\",\n \"\\\"\\\"\\\" return SQLQuery.join([k + ' = ' + sqlparam(v) for k, v in\",\n \">>> db = DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql: 'SELECT\",\n \"FROM foo'> >>> db.query(\\\"SELECT * FROM foo WHERE x = $x\\\", vars=dict(x='f'), _test=True)\",\n \"group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars):\",\n \"if isinstance(val, (int, long)): if sql == 'WHERE': nout = 'id = '\",\n \"return chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary` to an\",\n \"v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s)\",\n \"'%%' not in x: x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self):\",\n \"+ where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not\",\n \"% tablename + q(_keys) + ' VALUES ' + q(_values) else: sql_query =\",\n \"return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)):\",\n \"return other + self.sqlquery() def __str__(self): return str(self.value) def __repr__(self): return '<param: %s>'\",\n \"%s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass this\",\n \"obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj` to its proper SQL\",\n \"== \\\"{\\\": level = level + 1 elif token == \\\"}\\\": level =\",\n \"== \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1 while level:\",\n \"item in enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else:\",\n \">>> db.query(\\\"SELECT * FROM foo WHERE x = \\\" + sqlquote('f'), _test=True) <sql:\",\n \"SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values()\",\n \"2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary = dictionary.copy() # eval mucks\",\n \"self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return\",\n \"values from the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\\\"s =\",\n \"else: nout = reparam(val, svars) def xjoin(a, b): if a and b: return\",\n \"str: return obj.decode(encoding) elif t in [int, float, bool]: return unicode(obj) elif hasattr(obj,\",\n \"`using`. >>> db = DB(None, {}) >>> name = 'Joe' >>> db.delete('foo', where='name\",\n \"[] pos = 0 while 1: dollar = sformat.find(\\\"$\\\", pos) if dollar <\",\n \"sformat[tstart:tend] if token[0] in \\\"([\\\": level = level + 1 elif token[0] in\",\n \"sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\" # because `1 == True and hash(1)\",\n \"WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id\",\n \"= sformat.find(\\\"$\\\", pos) if dollar < 0: break nextchar = sformat[dollar + 1]\",\n \"where = \\\"id = \\\" + sqlparam(where) elif isinstance(where, (list, tuple)) and len(where)\",\n \"return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v\",\n \"= 't' AND y IN (2, 3)\\\"> \\\"\\\"\\\" if isinstance(a, list): return _sqllist(a)\",\n \"VALUES ' % (tablename, ', '.join(keys))) for i, row in enumerate(values): if i\",\n \"AND y = ' + sqlquote(3) <sql: \\\"WHERE x = 't' AND y\",\n \"import tokenprog tokenprog = tokenprog def matchorfail(text, pos): match = tokenprog.match(text, pos) if\",\n \"Otherwise, you can pass a dictionary to the keyword argument `vars` and the\",\n \"escaped if paramstyle in ['format', 'pyformat']: if '%' in x and '%%' not\",\n \"= db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q\",\n \"+ 1 elif token == \\\"}\\\": level = level - 1 chunks.append((1, sformat[dollar\",\n \"\\\"\\\"\\\" >>> _sqllist([1, 2, 3]) <sql: '(1, 2, 3)'> \\\"\\\"\\\" items = []\",\n \"because `1 == True and hash(1) == hash(True)` # we have to do\",\n \"repr(obj.isoformat()) else: if isinstance(obj, unicode): obj = obj.encode('utf8') return repr(obj) def sqllist(lst): \\\"\\\"\\\"\",\n \"nout) def _where(self, where, svars): if isinstance(where, (int, long)): where = \\\"id =\",\n \"+ (nextchar == \\\"$\\\") if pos < len(sformat): chunks.append((0, sformat[pos:])) return chunks def\",\n \"= self._where(where, svars) q = 'DELETE FROM ' + table if using: q\",\n \"q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \\\"\\\"\\\" s = [] for x\",\n \"SQLQuery): nout = val else: nout = reparam(val, svars) def xjoin(a, b): if\",\n \"the inserted rows. Set `seqname` to the ID if it's not the default,\",\n \"`1 == True and hash(1) == hash(True)` # we have to do this\",\n \"q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value): self.value = value def\",\n \"actual query. \\\"\\\"\\\" __slots__ = [\\\"items\\\"] # tested in sqlquote's docstring def __init__(self,\",\n \"gen_clause(self, sql, val, svars): if isinstance(val, (int, long)): if sql == 'WHERE': nout\",\n \"sformat[dollar + 1:pos])) else: chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1\",\n \"#coding:utf8 ''' Created on 2013-8-21 @author: lan (www.9miao.com) ''' import itertools import datetime\",\n \"test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql: \\\"SELECT * FROM test WHERE name='joe'\\\">\",\n \"tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with clause `where` (interpolated using\",\n \"VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES\",\n \"query # For backward compatability, ignore escaping when the query looks already escaped\",\n \"return SQLQuery.join([k + ' = ' + sqlparam(v) for k, v in dictionary.items()],\",\n \"if isinstance(sql_query, tuple): # for some databases, a separate query has to be\",\n \"`where` (interpolated using `vars`) and setting `values`. >>> db = DB(None, {}) >>>\",\n \"'bob', created = NOW() WHERE name = 'Joseph'\\\"> >>> q.query() 'UPDATE foo SET\",\n \"2, 1 while level: match, pos = matchorfail(sformat, pos) tstart, tend = match.regs[3]\",\n \"= SQLQuery(where[0], where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return\",\n \"it's not the default, or to `False` if there isn't one. >>> db\",\n \"test WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value):\",\n \"if _test: return sql_query db_cursor = self._db_cursor() if seqname is not False: sql_query\",\n \"keys. Returns the list of ids of the inserted rows. Set `seqname` to\",\n \"[2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" + x + \\\")\\\" if values:\",\n \"isinstance(items, SQLParam): self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items\",\n \">>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE x=', SQLParam(1)]) >>>\",\n \"SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test', ' WHERE\",\n \"b return xjoin(sql, nout) def _where(self, where, svars): if isinstance(where, (int, long)): where\",\n \"\\\"\\\"\\\" converts `obj` to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True)\",\n \"`where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each clause\",\n \"of strings and SQLParams, which get concatenated to produce the actual query. \\\"\\\"\\\"\",\n \"pos) if match is None: raise _ItplError(text, pos) return match, match.end() namechars =\",\n \"elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where def select(self,\",\n \"\\\"\\\"\\\" t = type(obj) if t is unicode: return obj elif t is\",\n \"q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\"\",\n \"* FROM foo\\\", _test=True) <sql: 'SELECT * FROM foo'> >>> db.query(\\\"SELECT * FROM\",\n \"string. >>> safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj,\",\n \"+ sqlwhere(values, ', ') + \\\" WHERE \\\" + where) if _test: return\",\n \"SQLQuery(object): \\\"\\\"\\\" You can pass this sort of thing as a clause in\",\n \"clauses `where`, `order`, `group`, `limit`, and `offset`. Uses vars to interpolate. Otherwise, each\",\n \"name, created) VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo (age, name,\",\n \"Ka-Ping Yee) \\\"\\\"\\\" from tokenize import tokenprog tokenprog = tokenprog def matchorfail(text, pos):\",\n \"for use in a SQL query. >>> 'WHERE x = ' + sqlquote(True)\",\n \"__slots__ = [\\\"items\\\"] # tested in sqlquote's docstring def __init__(self, items=None): r\\\"\\\"\\\"Creates a\",\n \"<sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\"\",\n \"' = ' + sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_,\",\n \"+ sqlquote(3) <sql: \\\"WHERE x = 't' AND y = 3\\\"> >>> 'WHERE\",\n \"self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname\",\n \"= DB(None, {}) >>> name = 'Joseph' >>> q = db.update('foo', where='name =\",\n \"val[1]) # backwards-compatibility elif isinstance(val, SQLQuery): nout = val else: nout = reparam(val,\",\n \"__str__(self): return safestr(self._str()) def __unicode__(self): return safeunicode(self._str()) def __repr__(self): return '<sql: %s>' %\",\n \"seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns current sequence ID. Set\",\n \">>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v\",\n \"make sure all keys are valid # make sure all rows have same\",\n \"db.update('foo', where='name = $name', name='bob', age=2, ... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql:\",\n \"= match.regs[3] token = sformat[tstart:tend] if token == \\\"{\\\": level = level +\",\n \"# for some databases, a separate query has to be made to find\",\n \"self.ctx.commit() return out def update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables`\",\n \"SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if\",\n \"to the ID if it's not the default, or to `False` if there\",\n \"chunks.append((0, sformat[pos:dollar + 1])) pos = dollar + 1 + (nextchar == \\\"$\\\")\",\n \"SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND\",\n \"same keys. for v in values: if v.keys() != keys: raise ValueError, 'Bad\",\n \"for v in values.values()], ', ') sql_query = \\\"INSERT INTO %s \\\" %\",\n \"level = level + 1 elif token[0] in \\\")]\\\": level = level -\",\n \"grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`.\",\n \"consists of `items`, which is a list of strings and SQLParams, which get\",\n \"if '%' in x and '%%' not in x: x = x.replace('%', '%%')\",\n \"values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()],\",\n \"reparam(\\\"s IN $s\\\", dict(s=[1, 2])) <sql: 's IN (1, 2)'> \\\"\\\"\\\" dictionary =\",\n \"values = [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values,\",\n \"def __repr__(self): return '<sql: %s>' % repr(str(self)) class SQLLiteral: \\\"\\\"\\\" Protects a string\",\n \"' + sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\"\",\n \"def __repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\"\",\n \"elif t is str: return obj.decode(encoding) elif t in [int, float, bool]: return\",\n \"\\\"\\\"\\\" if isinstance(a, list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes\",\n \"x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM foo WHERE x = \\\" +\",\n \"AND cust_id = 2'> >>> sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id =\",\n \"else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception:\",\n \"= [other] else: return NotImplemented return SQLQuery(items + self.items) def __iadd__(self, other): if\",\n \"of the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\",\",\n \"Uses vars to interpolate. Otherwise, each clause can be a SQLQuery. >>> db\",\n \"\\\"DELETE FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\" if svars is None: svars\",\n \"like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>>\",\n \"FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>>\",\n \"in self.items: if isinstance(x, SQLParam): x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x)\",\n \"enumerate(items): if i != 0: target_items.append(sep) if isinstance(item, SQLQuery): target_items.extend(item.items) else: target_items.append(item) if\",\n \"for i, v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')')\",\n \"raised for unsupported db paramstyles (currently supported: qmark, numeric, format, pyformat) \\\"\\\"\\\" pass\",\n \"isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def __add__(self, other): if\",\n \"a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM\",\n \"else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised for unsupported db paramstyles\",\n \"\\\"\\\"\\\" Selects `what` from `tables` with clauses `where`, `order`, `group`, `limit`, and `offset`.\",\n \"inserted rows. Set `seqname` to the ID if it's not the default, or\",\n \"return out keys = values[0].keys() #@@ make sure all keys are valid #\",\n \"provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(', suffix=')') <sql: '(a, b)'> If target\",\n \"list of ids of the inserted rows. Set `seqname` to the ID if\",\n \"with clause `where` (interpolated using `vars`) and setting `values`. >>> db = DB(None,\",\n \"svars=None, _test=False): \\\"\\\"\\\" Deletes from `table` with clauses `where` and `using`. >>> db\",\n \"values=values, _test=True) <sql: \\\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\">\",\n \"pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using dictionary `vars`\",\n \"is None: self.items = [] elif isinstance(items, list): self.items = items elif isinstance(items,\",\n \"WHERE x=', SQLParam(1)]) >>> q <sql: 'SELECT * FROM test WHERE x=1'> >>>\",\n \"SQL query. >>> 'WHERE x = ' + sqlquote(True) + ' AND y\",\n \"text, pos): ValueError.__init__(self) self.text = text self.pos = pos def __str__(self): return \\\"unfinished\",\n \"where[1]) elif isinstance(where, SQLQuery): pass else: where = reparam(where, svars) return where def\",\n \"INTO %s \\\" % tablename + q(_keys) + ' VALUES ' + q(_values)\",\n \"= target.items if prefix: target_items.append(prefix) for i, item in enumerate(items): if i !=\",\n \"return ':1' elif paramstyle is None or paramstyle in ['format', 'pyformat']: return '%s'\",\n \"= $name', vars=locals(), _test=True) <sql: \\\"DELETE FROM foo WHERE name = 'Joe'\\\"> \\\"\\\"\\\"\",\n \"' + b else: return a or b return xjoin(sql, nout) def _where(self,\",\n \"to do this the hard way... if obj is None: return 'NULL' elif\",\n \"databases, a separate query has to be made to find # the id\",\n \"= x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values of\",\n \"= self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a separate\",\n \"`table` with clauses `where` and `using`. >>> db = DB(None, {}) >>> name\",\n \"= sformat[tstart:tend] if token == \\\"{\\\": level = level + 1 elif token\",\n \"= {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset) clauses =\",\n \"self._where(where, svars) query = ( \\\"UPDATE \\\" + sqllist(tables) + \\\" SET \\\"\",\n \"Returns the list of ids of the inserted rows. Set `seqname` to the\",\n \"list(items.items) else: self.items = [items] # Take care of SQLLiterals for i, item\",\n \"\\\"\\\"\\\" if items is None: self.items = [] elif isinstance(items, list): self.items =\",\n \"\\\"\\\"\\\" if svars is None: svars = {} sql_clauses = self.sql_clauses(what, tables, where,\",\n \"self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self,\",\n \"string and returns a list of 2-tuples of the form (boolean, string) where\",\n \"if paramstyle in ['format', 'pyformat']: if '%' in x and '%%' not in\",\n \"elif hasattr(obj, 'next'): # iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj):\",\n \"= level + 1 elif token == \\\"}\\\": level = level - 1\",\n \"'<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You can pass\",\n \"x.replace('%', '%%') s.append(x) return \\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values of the\",\n \"\\\"\\\"\\\" items = [] items.append('(') for i, v in enumerate(values): if i !=\",\n \"the arguments for use in something like a WHERE clause. >>> sqllist(['a', 'b'])\",\n \"email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return [] if\",\n \"def matchorfail(text, pos): match = tokenprog.match(text, pos) if match is None: raise _ItplError(text,\",\n \"if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values]\",\n \"return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format string and returns a list\",\n \"data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys)))\",\n \"foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if svars is None: svars = {}\",\n \"The `values` must be a list of dictioanries, one for each row to\",\n \"Protects a string from `sqlquote`. >>> sqlquote('NOW()') <sql: \\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'>\",\n \"'SELECT * FROM foo'> >>> db.query(\\\"SELECT * FROM foo WHERE x = $x\\\",\",\n \"\\\"\\\"\\\" Deletes from `table` with clauses `where` and `using`. >>> db = DB(None,\",\n \"in enumerate(self.items): if isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self,\",\n \"+ \\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for\",\n \"format string and returns a list of 2-tuples of the form (boolean, string)\",\n \"_test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT *\",\n \"query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def\",\n \"WHERE x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is None: self.items\",\n \"VALUES\\\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows\",\n \"for you. Internally, consists of `items`, which is a list of strings and\",\n \"a list of 2-tuples of the form (boolean, string) where boolean says whether\",\n \"'b'}).query() 'a = %s AND b = %s' \\\"\\\"\\\" return SQLQuery.join([k + '\",\n \"can pass this sort of thing as a clause in any db function.\",\n \"a new SQLQuery. \\\"\\\"\\\" if target is None: target = SQLQuery() target_items =\",\n \"* FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.values() ['joe'] \\\"\\\"\\\" return [i.value for\",\n \"# iterator return itertools.imap(safestr, obj) else: return str(obj) def sqlify(obj): \\\"\\\"\\\" converts `obj`\",\n \"WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \\\"\\\"\\\" s =\",\n \"values: return [] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for\",\n \"return target join = staticmethod(join) def _str(self): try: return self.query() % tuple([sqlify(x) for\",\n \"raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES ' %\",\n \"Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname` to the ID\",\n \"x = \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x\",\n \"chunks.append((0, sformat[pos:])) return chunks def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary`\",\n \"else: return a or b return xjoin(sql, nout) def _where(self, where, svars): if\",\n \"safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return obj.encode(encoding) elif isinstance(obj, str): return obj\",\n \"q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam('joe')]) >>> q.query() 'SELECT *\",\n \"processed and not isinstance(sql_query, SQLQuery): sql_query = reparam(sql_query, svars) return sql_query def sql_clauses(self,\",\n \"1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2,\",\n \"__init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\" pass def query(self, sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL\",\n \"from `table` with clauses `where` and `using`. >>> db = DB(None, {}) >>>\",\n \"if values: _keys = SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in\",\n \"parameters used in the sql query. >>> q = SQLQuery([\\\"SELECT * FROM test\",\n \"q.query() 'SELECT * FROM test WHERE name=%s' >>> q.query(paramstyle='qmark') 'SELECT * FROM test\",\n \"self.sql_clauses(what, tables, where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for\",\n \"Ensures `a` is quoted properly for use in a SQL query. >>> 'WHERE\",\n \"( \\\"UPDATE \\\" + sqllist(tables) + \\\" SET \\\" + sqlwhere(values, ', ')\",\n \"<sql: 'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a\",\n \"= sformat[tstart:tend] if token[0] in \\\"([\\\": level = level + 1 elif token[0]\",\n \"__init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if paramstyle == 'qmark': return\",\n \"if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level = dollar + 2, 1\",\n \"prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided, the items are\",\n \"processed=True) def insert(self, tablename, seqname=None, _test=False, **values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns\",\n \"WHERE name=%s' >>> q.values() ['joe'] \\\"\\\"\\\" __slots__ = [\\\"value\\\"] def __init__(self, value): self.value\",\n \"[{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql:\",\n \"sql_clauses if val is not None] qout = SQLQuery.join(clauses) if _test: return qout\",\n \"' USING ' + sqllist(using) if where: q += ' WHERE ' +\",\n \"created) VALUES (2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo (age, name, created)\",\n \"foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM\",\n \"to find # the id of the inserted row. q1, q2 = sql_query\",\n \"!= 0: sql_query.append(\\\", \\\") SQLQuery.join([SQLParam(row[k]) for k in keys], sep=\\\", \\\", target=sql_query, prefix=\\\"(\\\",\",\n \"__repr__(self): return '<param: %s>' % repr(self.value) sqlparam = SQLParam class SQLQuery(object): \\\"\\\"\\\" You\",\n \"t in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode):\",\n \"list): return _sqllist(a) else: return sqlparam(a).sqlquery() def _interpolate(sformat): \\\"\\\"\\\" Takes a format string\",\n \"None: svars = {} sql_clauses = self.sql_clauses(what, tables, where, group, order, limit, offset)\",\n \"elif isinstance(val, (list, tuple)) and len(val) == 2: nout = SQLQuery(val[0], val[1]) #\",\n \"+ sqllist(using) if where: q += ' WHERE ' + where return q\",\n \"return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns the query part of the sql\",\n \"in sql_clauses if val is not None] qout = SQLQuery.join(clauses) if _test: return\",\n \"* FROM foo'> >>> db.query(\\\"SELECT * FROM foo WHERE x = $x\\\", vars=dict(x='f'),\",\n \"VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return [] if not\",\n \">>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t is\",\n \"there isn't one. >>> db = DB(None, {}) >>> db.supports_multiple_insert = True >>>\",\n \"a dictionary and interpolates the string using values from the dictionary. Returns an\",\n \"eval mucks with it result = [] for live, chunk in _interpolate(string_): if\",\n \"if not self.ctx.transactions: self.ctx.commit() return db_cursor.rowcount def delete(self, table, where, using=None, svars=None, _test=False):\",\n \"where = self._where(where, svars) query = ( \\\"UPDATE \\\" + sqllist(tables) + \\\"\",\n \"items.append(sqlparam(v)) items.append(')') return SQLQuery(items) def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly for\",\n \"'order_id = 3, cust_id = 2'> >>> sqlwhere({'a': 'a', 'b': 'b'}).query() 'a =\",\n \"`tablename`. Returns current sequence ID. Set `seqname` to the ID if it's not\",\n \"\\\"\\\"\\\" if target is None: target = SQLQuery() target_items = target.items if prefix:\",\n \"= sformat[dollar + 1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar])) pos, level =\",\n \"sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar])) match, pos\",\n \"a SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT *\",\n \"'): \\\"\\\"\\\" Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id':\",\n \"\\\"\\\"\\\" Returns the values of the parameters used in the sql query. >>>\",\n \"a and b: return a + ' ' + b else: return a\",\n \"False: return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if isinstance(obj,\",\n \"[] if not self.supports_multiple_insert: out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in\",\n \"''' import itertools import datetime def safeunicode(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any given object\",\n \"token = sformat[tstart:tend] if token == \\\"{\\\": level = level + 1 elif\",\n \"<sql: '(1, 2, 3)'> \\\"\\\"\\\" items = [] items.append('(') for i, v in\",\n \">>> q.query(paramstyle='qmark') 'SELECT * FROM test WHERE name=?' \\\"\\\"\\\" s = [] for\",\n \"where, group, order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val\",\n \"None: svars = {} where = self._where(where, svars) query = ( \\\"UPDATE \\\"\",\n \"Converts a `dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3})\",\n \"reparam(\\\"s = $s\\\", dict(s=True)) <sql: \\\"s = 't'\\\"> >>> reparam(\\\"s IN $s\\\", dict(s=[1,\",\n \"if seqname is False: return None else: return out keys = values[0].keys() #@@\",\n \"have same keys. for v in values: if v.keys() != keys: raise ValueError,\",\n \"!= keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT INTO %s (%s) VALUES\",\n \"sqllist(lst): \\\"\\\"\\\" Converts the arguments for use in something like a WHERE clause.\",\n \">>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\" if svars is None: svars = {}\",\n \"return NotImplemented return self def __len__(self): return len(self.query()) def query(self, paramstyle=None): \\\"\\\"\\\" Returns\",\n \"SQLQuery. \\\"\\\"\\\" if target is None: target = SQLQuery() target_items = target.items if\",\n \"\\\"'NOW()'\\\"> >>> sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v = v def\",\n \"svars) return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None,\",\n \"string. >>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t =\",\n \"SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def query(self,\",\n \"a dictionary to the keyword argument `vars` and the function will call reparam\",\n \"__slots__ = [\\\"value\\\"] def __init__(self, value): self.value = value def get_marker(self, paramstyle='pyformat'): if\",\n \"1 chunks.append((1, sformat[dollar + 2:pos - 1])) elif nextchar in namechars: chunks.append((0, sformat[pos:dollar]))\",\n \"target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a, b'>\",\n \"the function will call reparam for you. Internally, consists of `items`, which is\",\n \"WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc'\",\n \"\\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True) <sql: \\\"INSERT INTO person\",\n \"('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val, (int, long)):\",\n \"prefix=\\\"(\\\", suffix=\\\")\\\") if _test: return sql_query db_cursor = self._db_cursor() if seqname is not\",\n \"in something like a WHERE clause. >>> sqllist(['a', 'b']) 'a, b' >>> sqllist('a')\",\n \"proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3' \\\"\\\"\\\"\",\n \"Takes a string and a dictionary and interpolates the string using values from\",\n \"def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects\",\n \"svars is None: svars = {} where = self._where(where, svars) q = 'DELETE\",\n \"out def update(self, tables, where, svars=None, _test=False, **values): \\\"\\\"\\\" Update `tables` with clause\",\n \"\\\"SELECT * FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM test WHERE\",\n \"WHERE foo.bar_id = bar.id LIMIT 5'> \\\"\\\"\\\" if svars is None: svars =\",\n \"mucks with it result = [] for live, chunk in _interpolate(string_): if live:\",\n \"tend = match.regs[3] token = sformat[tstart:tend] if token[0] in \\\"([\\\": level = level\",\n \"prefix and suffix arguments can be provided. >>> SQLQuery.join(['a', 'b'], ', ', prefix='(',\",\n \"= pos + 1, 1 while level: match, pos = matchorfail(sformat, pos) tstart,\",\n \">>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" + x + \\\")\\\"\",\n \"bar.id\\\", limit=5, _test=True) <sql: 'SELECT * FROM foo, bar WHERE foo.bar_id = bar.id\",\n \"query looks already escaped if paramstyle in ['format', 'pyformat']: if '%' in x\",\n \"isinstance(item, SQLParam) and isinstance(item.value, SQLLiteral): self.items[i] = item.value.v def append(self, value): self.items.append(value) def\",\n \"$x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> >>>\",\n \"converts `obj` to its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\"\",\n \"is False: return \\\"'f'\\\" elif datetime and isinstance(obj, datetime.datetime): return repr(obj.isoformat()) else: if\",\n \"\\\"\\\"\\\" def __init__(self, v): self.v = v def __repr__(self): return self.v class SQLProducer:\",\n \"dictionary `vars` to interpolate it. If `processed=True`, `vars` is a `reparam`-style list to\",\n \"SQLQuery.join(values.keys(), ', ') _values = SQLQuery.join([sqlparam(v) for v in values.values()], ', ') sql_query\",\n \"the dictionary. Returns an `SQLQuery` for the result. >>> reparam(\\\"s = $s\\\", dict(s=True))\",\n \"if using: q += ' USING ' + sqllist(using) if where: q +=\",\n \"self.items = [items] elif isinstance(items, SQLQuery): self.items = list(items.items) else: self.items = [items]\",\n \"', ', prefix='(', suffix=')') <sql: '(a, b)'> If target argument is provided, the\",\n \"sqlparam(v) for k, v in dictionary.items()], grouping) def reparam(string_, dictionary): \\\"\\\"\\\" Takes a\",\n \"`SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'>\",\n \"sqlwhere({'cust_id': 2, 'order_id':3}, grouping=', ') <sql: 'order_id = 3, cust_id = 2'> >>>\",\n \"'SELECT * FROM test WHERE x=1'> >>> q.query(), q.values() ('SELECT * FROM test\",\n \"None] qout = SQLQuery.join(clauses) if _test: return qout return self.query(qout, processed=True) def insert(self,\",\n \"q2 = sql_query self._db_execute(db_cursor, q1) self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out =\",\n \"(2, 'bob', NOW())\\\"> >>> q.query() 'INSERT INTO foo (age, name, created) VALUES (%s,\",\n \"None: raise _ItplError(text, pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks\",\n \"made to find # the id of the inserted row. q1, q2 =\",\n \"safestr('hello') 'hello' >>> safestr(u'\\\\u1234') '\\\\xe1\\\\x88\\\\xb4' >>> safestr(2) '2' \\\"\\\"\\\" if isinstance(obj, unicode): return\",\n \"= eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class UnknownParamstyle(Exception): \\\"\\\"\\\" raised\",\n \"ids of the inserted rows. Set `seqname` to the ID if it's not\",\n \"None: target = SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item\",\n \"out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1) except Exception: out = None if\",\n \"def __init__(self, v): self.v = v def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\"\",\n \"%s DEFAULT VALUES\\\" % table def multiple_insert(self, tablename, values, seqname=None, _test=False): \\\"\\\"\\\" Inserts\",\n \"tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a separate query has\",\n \"= \\\"INSERT INTO %s \\\" % tablename + q(_keys) + ' VALUES '\",\n \"def _str(self): try: return self.query() % tuple([sqlify(x) for x in self.values()]) except (ValueError,\",\n \"svars) return sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset): return\",\n \"return SQLQuery(self.items + items) def __radd__(self, other): if isinstance(other, basestring): items = [other]\",\n \"other def __radd__(self, other): return other + self.sqlquery() def __str__(self): return str(self.value) def\",\n \"x=%s', [1]) >>> SQLQuery(SQLParam(1)) <sql: '1'> \\\"\\\"\\\" if items is None: self.items =\",\n \"= reparam(sql_query, svars) return sql_query def sql_clauses(self, what, tables, where, group, order, limit,\",\n \"escape % characters in the query # For backward compatability, ignore escaping when\",\n \"**values): \\\"\\\"\\\" Update `tables` with clause `where` (interpolated using `vars`) and setting `values`.\",\n \"escaping when the query looks already escaped if paramstyle in ['format', 'pyformat']: if\",\n \"sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst, basestring): return lst else: return ', '.join(lst) def\",\n \"WHERE \\\" + where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query)\",\n \"<sql: 'a, b'> Optinally, prefix and suffix arguments can be provided. >>> SQLQuery.join(['a',\",\n \"sqllist(['a', 'b']) 'a, b' >>> sqllist('a') 'a' >>> sqllist(u'abc') u'abc' \\\"\\\"\\\" if isinstance(lst,\",\n \"dictioanries, one for each row to be inserted, each with the same set\",\n \"self._db_execute(db_cursor, q2) else: self._db_execute(db_cursor, sql_query) try: out = db_cursor.fetchone()[0] out = range(out-len(values)+1, out+1)\",\n \"WHERE x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x\",\n \"is a `reparam`-style list to use instead of interpolating. >>> db = DB(None,\",\n \"'<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\" if not values: return [] if not self.supports_multiple_insert: out\",\n \"the parameters used in the sql query. >>> q = SQLQuery([\\\"SELECT * FROM\",\n \"('FROM', sqllist(tables)), ('WHERE', where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET',\",\n \"interpolating. >>> db = DB(None, {}) >>> db.query(\\\"SELECT * FROM foo\\\", _test=True) <sql:\",\n \"return where def select(self, tables, svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False):\",\n \"where) if _test: return query db_cursor = self._db_cursor() self._db_execute(db_cursor, query) if not self.ctx.transactions:\",\n \"= DB(None, {}) >>> q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q\",\n \"= matchorfail(sformat, dollar + 1) while pos < len(sformat): if sformat[pos] == \\\".\\\"\",\n \"BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self, sql, val, svars): if isinstance(val,\",\n \"compatability, ignore escaping when the query looks already escaped if paramstyle in ['format',\",\n \"sql_query def sql_clauses(self, what, tables, where, group, order, limit, offset): return ( ('SELECT',\",\n \"def __repr__(self): return self.v class SQLProducer: \\\"\\\"\\\"Database\\\"\\\"\\\" def __init__(self): \\\"\\\"\\\"Creates a database. \\\"\\\"\\\"\",\n \"match is None: raise _ItplError(text, pos) return match, match.end() namechars = \\\"abcdefghijklmnopqrstuvwxyz\\\" \\\\\",\n \"return \\\"(\\\" + x + \\\")\\\" if values: _keys = SQLQuery.join(values.keys(), ', ')\",\n \">>> q = SQLQuery([\\\"SELECT * FROM test WHERE name=\\\", SQLParam(\\\"joe\\\")]) >>> q <sql:\",\n \"# eval mucks with it result = [] for live, chunk in _interpolate(string_):\",\n \"order, limit, offset) clauses = [self.gen_clause(sql, val, svars) for sql, val in sql_clauses\",\n \"safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj) if t is unicode: return obj elif\",\n \"x in self.values()]) except (ValueError, TypeError): return self.query() def __str__(self): return safestr(self._str()) def\",\n \"... created=SQLLiteral('NOW()'), vars=locals(), _test=True) >>> q <sql: \\\"UPDATE foo SET age = 2,\",\n \">>> safeunicode('hello') u'hello' >>> safeunicode(2) u'2' >>> safeunicode('\\\\xe1\\\\x88\\\\xb4') u'\\\\u1234' \\\"\\\"\\\" t = type(obj)\",\n \"is None or paramstyle in ['format', 'pyformat']: return '%s' raise UnknownParamstyle, paramstyle def\",\n \"%d\\\" % ( repr(self.text), self.pos) class SQLParam(object): \\\"\\\"\\\" Parameter in SQLQuery. >>> q\",\n \"be inserted, each with the same set of keys. Returns the list of\",\n \"* FROM foo WHERE x = \\\" + sqlquote('f'), _test=True) <sql: \\\"SELECT *\",\n \"sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id = 3 AND cust_id = 2'> >>> sqlwhere({'cust_id':\",\n \"`vars` is a `reparam`-style list to use instead of interpolating. >>> db =\",\n \"\\\" % tablename + q(_keys) + ' VALUES ' + q(_values) else: sql_query\",\n \"suffix=None, target=None): \\\"\\\"\\\" Joins multiple queries. >>> SQLQuery.join(['a', 'b'], ', ') <sql: 'a,\",\n \"SQLQuery('INSERT INTO %s (%s) VALUES ' % (tablename, ', '.join(keys))) for i, row\",\n \"return SQLQuery([self]) def __add__(self, other): return self.sqlquery() + other def __radd__(self, other): return\",\n \"self._process_insert_query(sql_query, tablename, seqname) if isinstance(sql_query, tuple): # for some databases, a separate query\",\n \"the default, or to `False` if there isn't one. >>> db = DB(None,\",\n \"%s, NOW())' >>> q.values() [2, 'bob'] \\\"\\\"\\\" def q(x): return \\\"(\\\" + x\",\n \"def sqlquote(a): \\\"\\\"\\\" Ensures `a` is quoted properly for use in a SQL\",\n \"where), ('GROUP BY', group), ('ORDER BY', order), ('LIMIT', limit), ('OFFSET', offset)) def gen_clause(self,\",\n \"a SQL query. >>> 'WHERE x = ' + sqlquote(True) + ' AND\",\n \"_test=True) <sql: \\\"INSERT INTO person (name, email) VALUES ('foo', '<EMAIL>'), ('bar', '<EMAIL>')\\\"> \\\"\\\"\\\"\",\n \"out = [self.insert(tablename, seqname=seqname, _test=_test, **v) for v in values] if seqname is\",\n \"For backward compatability, ignore escaping when the query looks already escaped if paramstyle\",\n \"x and '%%' not in x: x = x.replace('%', '%%') s.append(x) return \\\"\\\".join(s)\",\n \"SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT * FROM ', 'test',\",\n \"if paramstyle == 'qmark': return '?' elif paramstyle == 'numeric': return ':1' elif\",\n \"is None: svars = {} if not processed and not isinstance(sql_query, SQLQuery): sql_query\",\n \"\\\"\\\".join(s) def values(self): \\\"\\\"\\\" Returns the values of the parameters used in the\",\n \"0: break nextchar = sformat[dollar + 1] if nextchar == \\\"{\\\": chunks.append((0, sformat[pos:dollar]))\",\n \"[] elif isinstance(items, list): self.items = items elif isinstance(items, SQLParam): self.items = [items]\",\n \"<sql: \\\"SELECT * FROM foo WHERE x = 'f'\\\"> >>> db.query(\\\"SELECT * FROM\",\n \"in values: if v.keys() != keys: raise ValueError, 'Bad data' sql_query = SQLQuery('INSERT\",\n \"svars=None, what='*', where=None, order=None, group=None, limit=None, offset=None, _test=False): \\\"\\\"\\\" Selects `what` from `tables`\",\n \"its proper SQL version >>> sqlify(None) 'NULL' >>> sqlify(True) \\\"'t'\\\" >>> sqlify(3) '3'\",\n \"tstart, tend = match.regs[3] token = sformat[tstart:tend] if token == \\\"{\\\": level =\",\n \"(basestring, SQLParam)): self.items.append(other) elif isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def\",\n \"created = NOW() WHERE name = %s' >>> q.values() [2, 'bob', 'Joseph'] \\\"\\\"\\\"\",\n \"if live: v = eval(chunk, dictionary) result.append(sqlquote(v)) else: result.append(chunk) return SQLQuery.join(result, '') class\",\n \"test WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM test WHERE name=%s' >>> q.values()\",\n \"isinstance(obj, unicode): return unicode(obj) else: return str(obj).decode(encoding) def safestr(obj, encoding='utf-8'): r\\\"\\\"\\\" Converts any\",\n \"= [{\\\"name\\\": \\\"foo\\\", \\\"email\\\": \\\"<EMAIL>\\\"}, {\\\"name\\\": \\\"bar\\\", \\\"email\\\": \\\"<EMAIL>\\\"}] >>> db.multiple_insert('person', values=values, _test=True)\",\n \"in [int, float, bool]: return unicode(obj) elif hasattr(obj, '__unicode__') or isinstance(obj, unicode): return\",\n \"i, v in enumerate(values): if i != 0: items.append(', ') items.append(sqlparam(v)) items.append(')') return\",\n \"the ID if it's not the default, or to `False` if there isn't\",\n \"= SQLQuery() target_items = target.items if prefix: target_items.append(prefix) for i, item in enumerate(items):\",\n \"level + 1 elif token == \\\"}\\\": level = level - 1 chunks.append((1,\",\n \"if suffix: target_items.append(suffix) return target join = staticmethod(join) def _str(self): try: return self.query()\",\n \"self.pos = pos def __str__(self): return \\\"unfinished expression in %s at char %d\\\"\",\n \"'WHERE x = ' + sqlquote(True) + ' AND y = ' +\",\n \"same set of keys. Returns the list of ids of the inserted rows.\",\n \"out keys = values[0].keys() #@@ make sure all keys are valid # make\",\n \"pos, level = dollar + 2, 1 while level: match, pos = matchorfail(sformat,\",\n \"x = x.get_marker(paramstyle) s.append(safestr(x)) else: x = safestr(x) # automatically escape % characters\",\n \"sqlquote(SQLLiteral('NOW()')) <sql: 'NOW()'> \\\"\\\"\\\" def __init__(self, v): self.v = v def __repr__(self): return\",\n \"`dictionary` to an SQL WHERE clause `SQLQuery`. >>> sqlwhere({'cust_id': 2, 'order_id':3}) <sql: 'order_id\",\n \"'b'], ', ') <sql: 'a, b'> Optinally, prefix and suffix arguments can be\",\n \"items=None): r\\\"\\\"\\\"Creates a new SQLQuery. >>> SQLQuery(\\\"x\\\") <sql: 'x'> >>> q = SQLQuery(['SELECT\",\n \"= SQLQuery(self._get_insert_default_values_query(tablename)) return sql_query def _get_insert_default_values_query(self, table): return \\\"INSERT INTO %s DEFAULT VALUES\\\"\",\n \"if isinstance(other, basestring): items = [other] else: return NotImplemented return SQLQuery(items + self.items)\",\n \"except Exception: out = None if not self.ctx.transactions: self.ctx.commit() return out def update(self,\",\n \"q = db.insert('foo', name='bob', age=2, created=SQLLiteral('NOW()'), _test=True) >>> q <sql: \\\"INSERT INTO foo\",\n \"**values): \\\"\\\"\\\" Inserts `values` into `tablename`. Returns current sequence ID. Set `seqname` to\",\n \"def sqlwhere(dictionary, grouping=' AND '): \\\"\\\"\\\" Converts a `dictionary` to an SQL WHERE\",\n \"<sql: \\\"SELECT * FROM test WHERE name='joe'\\\"> >>> q.query() 'SELECT * FROM test\",\n \"sql_query,processed=False, svars=None): \\\"\\\"\\\" Execute SQL query `sql_query` using dictionary `vars` to interpolate it.\",\n \"x = $x\\\", vars=dict(x='f'), _test=True) <sql: \\\"SELECT * FROM foo WHERE x =\",\n \"seqname=None, _test=False): \\\"\\\"\\\" Inserts multiple rows into `tablename`. The `values` must be a\",\n \"SQLQuery. >>> db = DB(None, {}) >>> db.select('foo', _test=True) <sql: 'SELECT * FROM\",\n \"SQLQuery(items + self.items) def __iadd__(self, other): if isinstance(other, (basestring, SQLParam)): self.items.append(other) elif isinstance(other,\",\n \"\\\\ \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\\\"; chunks = [] pos = 0 while 1: dollar = sformat.find(\\\"$\\\",\",\n \"= self._db_cursor() if seqname is not False: sql_query = self._process_insert_query(sql_query, tablename, seqname) if\",\n \"<sql: 'SELECT * FROM foo'> >>> db.select(['foo', 'bar'], where=\\\"foo.bar_id = bar.id\\\", limit=5, _test=True)\",\n \"\\\"\\\"\\\" # because `1 == True and hash(1) == hash(True)` # we have\"\n]","isConversational":false}}},{"rowIdx":271,"cells":{"ngram":{"kind":"list like","value":["'<KEY> # SECURITY WARNING: don't run with debug turned on in production! DEBUG","= [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ]","'UTC' USE_I18N = True USE_L10N = True USE_TZ = True # Static files","= { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME':","continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware',","None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR","{ 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST':","# Enforce a valid POSIX environment # Get missing environment variables via call","# Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os import","], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES =","if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE,","('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE =","_PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production","1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list","by 'django-admin startproject' using Django 1.8.2. For more information on this file, see","Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server',","True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__),","# django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT","paths inside the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import","os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization #","None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID':","django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT =","# Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp',","STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure #","'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME':","https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True","variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name',","settings for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For more","'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': {","os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } }","# Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True","file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values, see","[], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], },","'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages',","USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript, Images) #","for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used","= os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/","'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is","pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production #","for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For more information","see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/","# Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE',","run with debug turned on in production! DEBUG = True ALLOWED_HOSTS = [","secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug turned on","[ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug',","= True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT =","valid POSIX environment # Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE","for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] =","Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR,","inside the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd","'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for","True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin',","'django-admin startproject' using Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/","[ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' #","= True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES =","True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT","STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER =","'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in","}, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = {","Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full","import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment # Get","STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for","'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'),","'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER","SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY = '<KEY>","key used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run","# See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production","True USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript, Images)","keep the secret key used in production secret! SECRET_KEY = '<KEY> # SECURITY","For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of","= 'UTC' USE_I18N = True USE_L10N = True USE_TZ = True # Static","= True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/'","ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True,","dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For more information on","Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP =","except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware',","https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the project like this: os.path.join(BASE_DIR, ...) import","'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database","- unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret","more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY","pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment # Get missing","For the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" #","SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))","'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE","''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/","'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND':","'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in","'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE","_PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP,","'dddppp' # Enforce a valid POSIX environment # Get missing environment variables via","'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL':","call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name',","DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']),","'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE =","] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS':","Django settings for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For","# Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP","# see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True","''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au'","in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue","using Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the","): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware',","import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment","in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug","'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions',","like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp'","WARNING: keep the secret key used in production secret! SECRET_KEY = '<KEY> #","environment # Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None","'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases","'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES =","= True USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/","project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME =","os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE =","'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS':","settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the","'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env","'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True","('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES","True USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL","os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT',","= 'dddppp' # Enforce a valid POSIX environment # Get missing environment variables","\"\"\" # Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os","for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound,","set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del","...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a","'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates',","'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ],","del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable","(requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict,","#'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [],","'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid())","a valid POSIX environment # Get missing environment variables via call to pwd.getpwuid(...)","of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the","list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside","PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''),","WARNING: don't run with debug turned on in production! DEBUG = True ALLOWED_HOSTS","= [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF =","'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES =","don't run with debug turned on in production! DEBUG = True ALLOWED_HOSTS =","unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key","[ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for","} # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N =","'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE","'/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/","pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware',","missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = {","]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [","with debug turned on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost',","development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep","https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY","https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF =","JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE =","pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment #","}, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default':","'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth',","WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE':","= 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS':","(CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE","'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''),","'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, },","Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING:","see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF","= os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more","more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings","TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ = True #","the secret key used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING:","LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ","[ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions',","this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values,","[ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls'","'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES","try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware',","see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the project like this: os.path.join(BASE_DIR, ...)","{ 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD',","= [ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes',","= '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see:","project. Generated by 'django-admin startproject' using Django 1.8.2. For more information on this","# https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER':","options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY =","'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell',","debug turned on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ]","= 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ =","Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage'","'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [","Enforce a valid POSIX environment # Get missing environment variables via call to","pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #","= ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE","'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None:","SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True","SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES","= [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [","Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources","_PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR =","'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization","'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ = True","{ 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION =","pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ):","= pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))","'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application'","'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''),","] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except (","settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the project","'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES","via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER':","for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True","on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application","'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE","# Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT =","_PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings -","_PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID':","full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths","] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': {","values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the project like this: os.path.join(BASE_DIR,","USE_I18N = True USE_L10N = True USE_TZ = True # Static files (CSS,","= { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD':","and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the project like","( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware',","information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and","'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')","definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts',","True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = []","'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION","INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides',","'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try:","'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), }","See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret!","= None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid',","'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST',","'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT':","# SECURITY WARNING: don't run with debug turned on in production! DEBUG =","in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application definition","'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database #","= True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS = [","is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd","'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth)","turned on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] #","_PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for","'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]:","str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings","} } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N","secret key used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't","SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug turned on in","'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [","in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env]))","os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ #","production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS","PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment # Get missing environment","their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build paths inside the project like this:","https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\"","files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static')","os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce","used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with","_missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE,","USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL =","'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement,","'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ):","= 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO',","SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT","{ 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir',","os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX","os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE =","\"\"\" Django settings for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2.","True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True","} for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env]","# https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' #","pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware',","ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth',","'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages',","Generated by 'django-admin startproject' using Django 1.8.2. For more information on this file,","# https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N =","BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production # See","= '<KEY> # SECURITY WARNING: don't run with debug turned on in production!","= True USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript,","https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure","] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles',","_PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid',","# Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY","Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N","this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' #","production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in","https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER',","'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except","os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } #","= 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2',","'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement)","DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS =","startproject' using Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For","POSIX environment # Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE =","#SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY","True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ]","'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if","os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start","the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME","TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors':","production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug turned","pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name',","environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME':","SECURITY WARNING: don't run with debug turned on in production! DEBUG = True","on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their","= True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY =","# SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY =","{ 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request',","pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware',","INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ]","the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \"\"\" # Build","import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid","'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ {","to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME':","[ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth)","Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME),","= str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development","os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options","''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC'","'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', }","MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF"],"string":"[\n \"'<KEY> # SECURITY WARNING: don't run with debug turned on in production! DEBUG\",\n \"= [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ]\",\n \"'UTC' USE_I18N = True USE_L10N = True USE_TZ = True # Static files\",\n \"= { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME':\",\n \"continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware',\",\n \"None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR\",\n \"{ 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST':\",\n \"# Enforce a valid POSIX environment # Get missing environment variables via call\",\n \"# Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os import\",\n \"], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES =\",\n \"if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE,\",\n \"('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE =\",\n \"_PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production\",\n \"1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list\",\n \"by 'django-admin startproject' using Django 1.8.2. For more information on this file, see\",\n \"Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server',\",\n \"True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__),\",\n \"# django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT\",\n \"paths inside the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import\",\n \"os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization #\",\n \"None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID':\",\n \"django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT =\",\n \"# Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp',\",\n \"STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure #\",\n \"'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME':\",\n \"https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True\",\n \"variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name',\",\n \"settings for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For more\",\n \"'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': {\",\n \"os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } }\",\n \"# Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True\",\n \"file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values, see\",\n \"[], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], },\",\n \"'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages',\",\n \"USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript, Images) #\",\n \"for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used\",\n \"= os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/\",\n \"'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is\",\n \"pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production #\",\n \"for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For more information\",\n \"see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/\",\n \"# Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE',\",\n \"run with debug turned on in production! DEBUG = True ALLOWED_HOSTS = [\",\n \"secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug turned on\",\n \"[ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug',\",\n \"= True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT =\",\n \"valid POSIX environment # Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE\",\n \"for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] =\",\n \"Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR,\",\n \"inside the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd\",\n \"'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for\",\n \"True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin',\",\n \"'django-admin startproject' using Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/\",\n \"[ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' #\",\n \"= True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES =\",\n \"True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT\",\n \"STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER =\",\n \"'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in\",\n \"}, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = {\",\n \"Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full\",\n \"import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment # Get\",\n \"STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for\",\n \"'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'),\",\n \"'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER\",\n \"SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY = '<KEY>\",\n \"key used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run\",\n \"# See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production\",\n \"True USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript, Images)\",\n \"keep the secret key used in production secret! SECRET_KEY = '<KEY> # SECURITY\",\n \"For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of\",\n \"= 'UTC' USE_I18N = True USE_L10N = True USE_TZ = True # Static\",\n \"= True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/'\",\n \"ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True,\",\n \"dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For more information on\",\n \"Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP =\",\n \"except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware',\",\n \"https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the project like this: os.path.join(BASE_DIR, ...) import\",\n \"'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database\",\n \"- unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret\",\n \"more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY\",\n \"pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment # Get missing\",\n \"For the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" #\",\n \"SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))\",\n \"'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE\",\n \"''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/\",\n \"'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND':\",\n \"'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in\",\n \"'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE\",\n \"_PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP,\",\n \"'dddppp' # Enforce a valid POSIX environment # Get missing environment variables via\",\n \"'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL':\",\n \"call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name',\",\n \"DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']),\",\n \"'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE =\",\n \"] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS':\",\n \"Django settings for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2. For\",\n \"# Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP\",\n \"# see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True\",\n \"''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au'\",\n \"in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue\",\n \"using Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the\",\n \"): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware',\",\n \"import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment\",\n \"in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug\",\n \"'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions',\",\n \"like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp'\",\n \"WARNING: keep the secret key used in production secret! SECRET_KEY = '<KEY> #\",\n \"environment # Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None\",\n \"'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases\",\n \"'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES =\",\n \"= True USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/\",\n \"project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME =\",\n \"os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE =\",\n \"'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS':\",\n \"settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the\",\n \"'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env\",\n \"'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True\",\n \"('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES\",\n \"True USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL\",\n \"os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT',\",\n \"= 'dddppp' # Enforce a valid POSIX environment # Get missing environment variables\",\n \"\\\"\\\"\\\" # Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os\",\n \"for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound,\",\n \"set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del\",\n \"...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a\",\n \"'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates',\",\n \"'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ],\",\n \"del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable\",\n \"(requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict,\",\n \"#'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [],\",\n \"'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid())\",\n \"a valid POSIX environment # Get missing environment variables via call to pwd.getpwuid(...)\",\n \"of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the\",\n \"list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside\",\n \"PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''),\",\n \"WARNING: don't run with debug turned on in production! DEBUG = True ALLOWED_HOSTS\",\n \"= [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF =\",\n \"'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES =\",\n \"don't run with debug turned on in production! DEBUG = True ALLOWED_HOSTS =\",\n \"unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key\",\n \"[ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for\",\n \"} # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N =\",\n \"'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE\",\n \"'/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/\",\n \"pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware',\",\n \"missing environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = {\",\n \"]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [\",\n \"with debug turned on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost',\",\n \"development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep\",\n \"https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY\",\n \"https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF =\",\n \"JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE =\",\n \"pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment #\",\n \"}, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default':\",\n \"'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth',\",\n \"WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE':\",\n \"= 'dddppp.urls' TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS':\",\n \"(CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE\",\n \"'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''),\",\n \"'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, },\",\n \"Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING:\",\n \"see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF\",\n \"= os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more\",\n \"more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings\",\n \"TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ = True #\",\n \"the secret key used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING:\",\n \"LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ\",\n \"[ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions',\",\n \"this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values,\",\n \"[ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls'\",\n \"'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES\",\n \"try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware',\",\n \"see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the project like this: os.path.join(BASE_DIR, ...)\",\n \"{ 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD',\",\n \"= [ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes',\",\n \"= '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see:\",\n \"project. Generated by 'django-admin startproject' using Django 1.8.2. For more information on this\",\n \"# https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER':\",\n \"options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY =\",\n \"'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell',\",\n \"debug turned on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ]\",\n \"= 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ =\",\n \"Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage'\",\n \"'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [\",\n \"Enforce a valid POSIX environment # Get missing environment variables via call to\",\n \"pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #\",\n \"= ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE\",\n \"'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None:\",\n \"SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True\",\n \"SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES\",\n \"= [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [\",\n \"Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources\",\n \"_PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR =\",\n \"'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization\",\n \"'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N = True USE_TZ = True\",\n \"{ 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION =\",\n \"pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ):\",\n \"= pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\",\n \"'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application'\",\n \"'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''),\",\n \"] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except (\",\n \"settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the project\",\n \"'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES\",\n \"via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER':\",\n \"for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') #SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True\",\n \"on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application\",\n \"'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE\",\n \"# Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT =\",\n \"_PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings -\",\n \"_PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID':\",\n \"full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths\",\n \"] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': {\",\n \"values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the project like this: os.path.join(BASE_DIR,\",\n \"USE_I18N = True USE_L10N = True USE_TZ = True # Static files (CSS,\",\n \"= { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD':\",\n \"and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the project like\",\n \"( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware',\",\n \"information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and\",\n \"'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')\",\n \"definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts',\",\n \"True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = []\",\n \"'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION\",\n \"INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides',\",\n \"'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try:\",\n \"'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), }\",\n \"See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret!\",\n \"= None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid',\",\n \"'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST',\",\n \"'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER', os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT':\",\n \"# SECURITY WARNING: don't run with debug turned on in production! DEBUG =\",\n \"in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application definition\",\n \"'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ] WSGI_APPLICATION = 'dddppp.wsgi.application' # Database #\",\n \"= True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS = [\",\n \"is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd\",\n \"'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth)\",\n \"turned on in production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] #\",\n \"_PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for\",\n \"'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]:\",\n \"str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings\",\n \"} } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N\",\n \"secret key used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't\",\n \"SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug turned on in\",\n \"'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [\",\n \"in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env]))\",\n \"os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ #\",\n \"production! DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS\",\n \"PROJECT_NAME = 'dddppp' # Enforce a valid POSIX environment # Get missing environment\",\n \"their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build paths inside the project like this:\",\n \"https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\"\",\n \"files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static')\",\n \"os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce\",\n \"used in production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with\",\n \"_missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env] = str(getattr(_PW_CACHE,\",\n \"USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL =\",\n \"'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ] for (requirement,\",\n \"'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ):\",\n \"= 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO',\",\n \"SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True DDDPPP_CONTENT_TYPES = [] PROJ_ROOT\",\n \"{ 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir',\",\n \"os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid POSIX\",\n \"os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE =\",\n \"\\\"\\\"\\\" Django settings for dddppp project. Generated by 'django-admin startproject' using Django 1.8.2.\",\n \"True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY = True\",\n \"} for _missing_env in set(_PW_MAP).difference(os.environ): if _PW_CACHE is None: _PW_CACHE = pwd.getpwuid(os.getuid()) os.environ[_missing_env]\",\n \"# https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' #\",\n \"pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware',\",\n \"ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth',\",\n \"'localhost', ] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages',\",\n \"Generated by 'django-admin startproject' using Django 1.8.2. For more information on this file,\",\n \"# https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N =\",\n \"BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development settings - unsuitable for production # See\",\n \"= '<KEY> # SECURITY WARNING: don't run with debug turned on in production!\",\n \"= True USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript,\",\n \"https://docs.djangoproject.com/en/1.8/howto/static-files/ STATIC_URL = '/static/' STATIC_ROOT = os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure\",\n \"] # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles',\",\n \"_PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid',\",\n \"# Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY\",\n \"Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC' USE_I18N = True USE_L10N\",\n \"this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' #\",\n \"production # See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in\",\n \"https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME), 'USER': os.environ.get('PGUSER',\",\n \"'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except\",\n \"os.environ['LOGNAME']), 'PASSWORD': os.environ.get('DJANGO_DATABASE_PASSWORD', ''), 'HOST': os.environ.get('PGHOST', ''), 'PORT': os.environ.get('PGPORT', ''), } } #\",\n \"= 'dddppp.wsgi.application' # Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2',\",\n \"'dddp.accounts', 'dddppp.slides', ] for (requirement, pth) in [ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement)\",\n \"DEBUG = True ALLOWED_HOSTS = [ 'localhost', ] # Application definition INSTALLED_APPS =\",\n \"startproject' using Django 1.8.2. For more information on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For\",\n \"POSIX environment # Get missing environment variables via call to pwd.getpwuid(...) _PW_CACHE =\",\n \"#SECURE_SSL_REDIRECT = True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY\",\n \"True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ]\",\n \"'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', } for _missing_env in set(_PW_MAP).difference(os.environ): if\",\n \"os.environ[_missing_env] = str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start\",\n \"the project like this: os.path.join(BASE_DIR, ...) import os import pkg_resources import pwd PROJECT_NAME\",\n \"TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors':\",\n \"production secret! SECRET_KEY = '<KEY> # SECURITY WARNING: don't run with debug turned\",\n \"pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME': 'pw_name',\",\n \"environment variables via call to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME':\",\n \"SECURITY WARNING: don't run with debug turned on in production! DEBUG = True\",\n \"on this file, see https://docs.djangoproject.com/en/1.8/topics/settings/ For the full list of settings and their\",\n \"= True SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_FRAME_DENY = True SESSION_COOKIE_SECURE = True SESSION_COOKIE_HTTPONLY =\",\n \"# SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY =\",\n \"{ 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request',\",\n \"pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware',\",\n \"INSTALLED_APPS.append(pth) MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ]\",\n \"the full list of settings and their values, see https://docs.djangoproject.com/en/1.8/ref/settings/ \\\"\\\"\\\" # Build\",\n \"import os import pkg_resources import pwd PROJECT_NAME = 'dddppp' # Enforce a valid\",\n \"'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF = 'dddppp.urls' TEMPLATES = [ {\",\n \"to pwd.getpwuid(...) _PW_CACHE = None _PW_MAP = { 'LOGNAME': 'pw_name', 'USER': 'pw_name', 'USERNAME':\",\n \"[ ('django-extensions', 'django_extensions'), ]: try: pkg_resources.get_distribution(requirement) except ( pkg_resources.DistributionNotFound, pkg_resources.VersionConflict, ): continue INSTALLED_APPS.append(pth)\",\n \"Database # https://docs.djangoproject.com/en/1.8/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': os.environ.get('PGDATABASE', PROJECT_NAME),\",\n \"= str(getattr(_PW_CACHE, _PW_MAP[_missing_env])) del _PW_CACHE, _PW_MAP, pwd BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Quick-start development\",\n \"os.path.join(BASE_DIR, 'static') STATICFILES_STORAGE = 'whitenoise.django.GzipManifestStaticFilesStorage' # django-secure # see: https://github.com/carljm/django-secure/ for more options\",\n \"''), } } # Internationalization # https://docs.djangoproject.com/en/1.8/topics/i18n/ LANGUAGE_CODE = 'en-au' TIME_ZONE = 'UTC'\",\n \"'USER': 'pw_name', 'USERNAME': 'pw_name', 'UID': 'pw_uid', 'GID': 'pw_gid', 'HOME': 'pw_dir', 'SHELL': 'pw_shell', }\",\n \"MIDDLEWARE_CLASSES = [ 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', #'django.middleware.security.SecurityMiddleware', ] ROOT_URLCONF\"\n]","isConversational":false}}},{"rowIdx":272,"cells":{"ngram":{"kind":"list like","value":["python from setuptools import setup import os __doc__ = \"\"\" Command line tool","#!/usr/bin/env python from setuptools import setup import os __doc__ = \"\"\" Command line",":: BSD License\", \"Topic :: System :: Networking\", \"Operating System :: POSIX ::","return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except:","fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version","install_requires=install_requires, classifiers=[ \"License :: OSI Approved :: BSD License\", \"Topic :: System ::",":: Python :: 2.7\", \"Programming Language :: Python :: 3.3\", ], data_files=[ ('/etc/bash_completion.d/',","2.6\", \"Programming Language :: Python :: 2.7\", \"Programming Language :: Python :: 3.3\",","Networking\", \"Operating System :: POSIX :: Linux\", \"Environment :: Console\", \"Programming Language ::","os __doc__ = \"\"\" Command line tool and library wrappers around iwlist and","/etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ]","version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[","library wrappers around iwlist and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires","import os __doc__ = \"\"\" Command line tool and library wrappers around iwlist","name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires,","'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi',","\"Programming Language :: Python :: 2.6\", \"Programming Language :: Python :: 2.7\", \"Programming","long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved ::","] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>,","version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'],","Python :: 2.7\", \"Programming Language :: Python :: 3.3\", ], data_files=[ ('/etc/bash_completion.d/', ['extras/wifi-completion.bash']),","and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2',",":: Linux\", \"Environment :: Console\", \"Programming Language :: Python\", \"Programming Language :: Python",":: Console\", \"Programming Language :: Python\", \"Programming Language :: Python :: 2.6\", \"Programming","and library wrappers around iwlist and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read()","wrappers around iwlist and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires =","setup import os __doc__ = \"\"\" Command line tool and library wrappers around","packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved :: BSD","Language :: Python :: 2.6\", \"Programming Language :: Python :: 2.7\", \"Programming Language","= \"\"\" Command line tool and library wrappers around iwlist and /etc/network/interfaces. \"\"\"","\"Operating System :: POSIX :: Linux\", \"Environment :: Console\", \"Programming Language :: Python\",","description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved","argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__,","BSD License\", \"Topic :: System :: Networking\", \"Operating System :: POSIX :: Linux\",","Console\", \"Programming Language :: Python\", \"Programming Language :: Python :: 2.6\", \"Programming Language","System :: Networking\", \"Operating System :: POSIX :: Linux\", \"Environment :: Console\", \"Programming","Approved :: BSD License\", \"Topic :: System :: Networking\", \"Operating System :: POSIX","license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved :: BSD License\", \"Topic :: System","Language :: Python\", \"Programming Language :: Python :: 2.6\", \"Programming Language :: Python","License\", \"Topic :: System :: Networking\", \"Operating System :: POSIX :: Linux\", \"Environment","[ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup(","Python :: 2.6\", \"Programming Language :: Python :: 2.7\", \"Programming Language :: Python","try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>',","install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'],","test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved :: BSD License\", \"Topic",":: Networking\", \"Operating System :: POSIX :: Linux\", \"Environment :: Console\", \"Programming Language","<filename>setup.py #!/usr/bin/env python from setuptools import setup import os __doc__ = \"\"\" Command","__doc__ = \"\"\" Command line tool and library wrappers around iwlist and /etc/network/interfaces.","\"License :: OSI Approved :: BSD License\", \"Topic :: System :: Networking\", \"Operating","\"Environment :: Console\", \"Programming Language :: Python\", \"Programming Language :: Python :: 2.6\",","tool and library wrappers around iwlist and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__),",":: POSIX :: Linux\", \"Environment :: Console\", \"Programming Language :: Python\", \"Programming Language","except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'),","import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>',",":: System :: Networking\", \"Operating System :: POSIX :: Linux\", \"Environment :: Console\",","Linux\", \"Environment :: Console\", \"Programming Language :: Python\", \"Programming Language :: Python ::","Language :: Python :: 2.7\", \"Programming Language :: Python :: 3.3\", ], data_files=[",":: OSI Approved :: BSD License\", \"Topic :: System :: Networking\", \"Operating System","def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import","author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI","import setup import os __doc__ = \"\"\" Command line tool and library wrappers",":: Python\", \"Programming Language :: Python :: 2.6\", \"Programming Language :: Python ::","2.7\", \"Programming Language :: Python :: 3.3\", ], data_files=[ ('/etc/bash_completion.d/', ['extras/wifi-completion.bash']), ] )","\"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try:",":: Python :: 2.6\", \"Programming Language :: Python :: 2.7\", \"Programming Language ::",":: 2.6\", \"Programming Language :: Python :: 2.7\", \"Programming Language :: Python ::","System :: POSIX :: Linux\", \"Environment :: Console\", \"Programming Language :: Python\", \"Programming","author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License","line tool and library wrappers around iwlist and /etc/network/interfaces. \"\"\" def read(fname): return","= '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests',","setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD',","platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved :: BSD License\", \"Topic ::","<NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License ::","read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse","'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version,","\"\"\" Command line tool and library wrappers around iwlist and /etc/network/interfaces. \"\"\" def","from setuptools import setup import os __doc__ = \"\"\" Command line tool and","scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"], license='BSD', install_requires=install_requires, classifiers=[ \"License :: OSI Approved :: BSD License\",","iwlist and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools',","'1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\"Debian\"],","= [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0'","\"Programming Language :: Python\", \"Programming Language :: Python :: 2.6\", \"Programming Language ::","POSIX :: Linux\", \"Environment :: Console\", \"Programming Language :: Python\", \"Programming Language ::",":: 2.7\", \"Programming Language :: Python :: 3.3\", ], data_files=[ ('/etc/bash_completion.d/', ['extras/wifi-completion.bash']), ]","around iwlist and /etc/network/interfaces. \"\"\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [","open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse')","install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version =","Python\", \"Programming Language :: Python :: 2.6\", \"Programming Language :: Python :: 2.7\",","Command line tool and library wrappers around iwlist and /etc/network/interfaces. \"\"\" def read(fname):","\"Topic :: System :: Networking\", \"Operating System :: POSIX :: Linux\", \"Environment ::","\"Programming Language :: Python :: 2.7\", \"Programming Language :: Python :: 3.3\", ],","classifiers=[ \"License :: OSI Approved :: BSD License\", \"Topic :: System :: Networking\",","setuptools import setup import os __doc__ = \"\"\" Command line tool and library","OSI Approved :: BSD License\", \"Topic :: System :: Networking\", \"Operating System ::"],"string":"[\n \"python from setuptools import setup import os __doc__ = \\\"\\\"\\\" Command line tool\",\n \"#!/usr/bin/env python from setuptools import setup import os __doc__ = \\\"\\\"\\\" Command line\",\n \":: BSD License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating System :: POSIX ::\",\n \"return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except:\",\n \"fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version\",\n \"install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved :: BSD License\\\", \\\"Topic :: System ::\",\n \":: Python :: 2.7\\\", \\\"Programming Language :: Python :: 3.3\\\", ], data_files=[ ('/etc/bash_completion.d/',\",\n \"2.6\\\", \\\"Programming Language :: Python :: 2.7\\\", \\\"Programming Language :: Python :: 3.3\\\",\",\n \"Networking\\\", \\\"Operating System :: POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language ::\",\n \"os __doc__ = \\\"\\\"\\\" Command line tool and library wrappers around iwlist and\",\n \"/etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ]\",\n \"version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[\",\n \"library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires\",\n \"import os __doc__ = \\\"\\\"\\\" Command line tool and library wrappers around iwlist\",\n \"name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires,\",\n \"'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi',\",\n \"\\\"Programming Language :: Python :: 2.6\\\", \\\"Programming Language :: Python :: 2.7\\\", \\\"Programming\",\n \"long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved ::\",\n \"] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>,\",\n \"version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'],\",\n \"Python :: 2.7\\\", \\\"Programming Language :: Python :: 3.3\\\", ], data_files=[ ('/etc/bash_completion.d/', ['extras/wifi-completion.bash']),\",\n \"and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2',\",\n \":: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language :: Python\",\n \":: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language :: Python :: 2.6\\\", \\\"Programming\",\n \"and library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read()\",\n \"wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires =\",\n \"setup import os __doc__ = \\\"\\\"\\\" Command line tool and library wrappers around\",\n \"packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved :: BSD\",\n \"Language :: Python :: 2.6\\\", \\\"Programming Language :: Python :: 2.7\\\", \\\"Programming Language\",\n \"= \\\"\\\"\\\" Command line tool and library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\"\",\n \"\\\"Operating System :: POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\",\",\n \"description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved\",\n \"argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__,\",\n \"BSD License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating System :: POSIX :: Linux\\\",\",\n \"Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language :: Python :: 2.6\\\", \\\"Programming Language\",\n \"System :: Networking\\\", \\\"Operating System :: POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming\",\n \"Approved :: BSD License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating System :: POSIX\",\n \"license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved :: BSD License\\\", \\\"Topic :: System\",\n \"Language :: Python\\\", \\\"Programming Language :: Python :: 2.6\\\", \\\"Programming Language :: Python\",\n \"License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating System :: POSIX :: Linux\\\", \\\"Environment\",\n \"[ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup(\",\n \"Python :: 2.6\\\", \\\"Programming Language :: Python :: 2.7\\\", \\\"Programming Language :: Python\",\n \"try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>',\",\n \"install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'],\",\n \"test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved :: BSD License\\\", \\\"Topic\",\n \":: Networking\\\", \\\"Operating System :: POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language\",\n \"<filename>setup.py #!/usr/bin/env python from setuptools import setup import os __doc__ = \\\"\\\"\\\" Command\",\n \"__doc__ = \\\"\\\"\\\" Command line tool and library wrappers around iwlist and /etc/network/interfaces.\",\n \"\\\"License :: OSI Approved :: BSD License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating\",\n \"\\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language :: Python :: 2.6\\\",\",\n \"tool and library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__),\",\n \":: POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language\",\n \"except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'),\",\n \"import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>',\",\n \":: System :: Networking\\\", \\\"Operating System :: POSIX :: Linux\\\", \\\"Environment :: Console\\\",\",\n \"Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language :: Python ::\",\n \"Language :: Python :: 2.7\\\", \\\"Programming Language :: Python :: 3.3\\\", ], data_files=[\",\n \":: OSI Approved :: BSD License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating System\",\n \"def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import\",\n \"author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI\",\n \"import setup import os __doc__ = \\\"\\\"\\\" Command line tool and library wrappers\",\n \":: Python\\\", \\\"Programming Language :: Python :: 2.6\\\", \\\"Programming Language :: Python ::\",\n \"2.7\\\", \\\"Programming Language :: Python :: 3.3\\\", ], data_files=[ ('/etc/bash_completion.d/', ['extras/wifi-completion.bash']), ] )\",\n \"\\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try:\",\n \":: Python :: 2.6\\\", \\\"Programming Language :: Python :: 2.7\\\", \\\"Programming Language ::\",\n \":: 2.6\\\", \\\"Programming Language :: Python :: 2.7\\\", \\\"Programming Language :: Python ::\",\n \"System :: POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming\",\n \"author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License\",\n \"line tool and library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return\",\n \"= '1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests',\",\n \"setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD',\",\n \"platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved :: BSD License\\\", \\\"Topic ::\",\n \"<NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License ::\",\n \"read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse\",\n \"'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0' setup( name='wifi', version=version,\",\n \"\\\"\\\"\\\" Command line tool and library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def\",\n \"from setuptools import setup import os __doc__ = \\\"\\\"\\\" Command line tool and\",\n \"scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"], license='BSD', install_requires=install_requires, classifiers=[ \\\"License :: OSI Approved :: BSD License\\\",\",\n \"iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools',\",\n \"'1.0.0' setup( name='wifi', version=version, author='<NAME>, <NAME>', author_email='<EMAIL>', description=__doc__, long_description=read('README.rst'), packages=['wifi'], scripts=['bin/wifi'], test_suite='tests', platforms=[\\\"Debian\\\"],\",\n \"= [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version = '1.0.0'\",\n \"\\\"Programming Language :: Python\\\", \\\"Programming Language :: Python :: 2.6\\\", \\\"Programming Language ::\",\n \"POSIX :: Linux\\\", \\\"Environment :: Console\\\", \\\"Programming Language :: Python\\\", \\\"Programming Language ::\",\n \":: 2.7\\\", \\\"Programming Language :: Python :: 3.3\\\", ], data_files=[ ('/etc/bash_completion.d/', ['extras/wifi-completion.bash']), ]\",\n \"around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [\",\n \"open(os.path.join(os.path.dirname(__file__), fname)).read() install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse')\",\n \"install_requires = [ 'setuptools', 'pbkdf2', ] try: import argparse except: install_requires.append('argparse') version =\",\n \"Python\\\", \\\"Programming Language :: Python :: 2.6\\\", \\\"Programming Language :: Python :: 2.7\\\",\",\n \"Command line tool and library wrappers around iwlist and /etc/network/interfaces. \\\"\\\"\\\" def read(fname):\",\n \"\\\"Topic :: System :: Networking\\\", \\\"Operating System :: POSIX :: Linux\\\", \\\"Environment ::\",\n \"\\\"Programming Language :: Python :: 2.7\\\", \\\"Programming Language :: Python :: 3.3\\\", ],\",\n \"classifiers=[ \\\"License :: OSI Approved :: BSD License\\\", \\\"Topic :: System :: Networking\\\",\",\n \"setuptools import setup import os __doc__ = \\\"\\\"\\\" Command line tool and library\",\n \"OSI Approved :: BSD License\\\", \\\"Topic :: System :: Networking\\\", \\\"Operating System ::\"\n]","isConversational":false}}},{"rowIdx":273,"cells":{"ngram":{"kind":"list like","value":["auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance()","endpoints for managing an Org resource.\"\"\" from flask import request from flask_restplus import","Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('',","KIND, either express or implied. # See the License for the specific language","schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id,","Unless required by applicable law or agreed to in writing, software # distributed","You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 #","# See the License for the specific language governing permissions and # limitations","Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for","specific language governing permissions and # limitations under the License. \"\"\"API endpoints for","License. # You may obtain a copy of the License at # #","auth_api import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper","management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class","valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is","= Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS')","import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management')","distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY","else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception:","'License'); # you may not use this file except in compliance with the","the License. \"\"\"API endpoints for managing an Org resource.\"\"\" from flask import request","law or agreed to in writing, software # distributed under the License is","auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import Product","= JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product","the License for the specific language governing permissions and # limitations under the","Apache License, Version 2.0 (the 'License'); # you may not use this file","compliance with the License. # You may obtain a copy of the License","import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from","the org using the request body.\"\"\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json,","Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER","@_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product subscription to the org using the","authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions,","Province of British Columbia # # Licensed under the Apache License, Version 2.0","Licensed under the Apache License, Version 2.0 (the 'License'); # you may not","this file except in compliance with the License. # You may obtain a","products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS'])","import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT","under the Apache License, Version 2.0 (the 'License'); # you may not use","managing an Org resource.\"\"\" from flask import request from flask_restplus import Namespace, Resource,","you may not use this file except in compliance with the License. #","British Columbia # # Licensed under the Apache License, Version 2.0 (the 'License');","of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable","ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight","\"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a","resource.\"\"\" from flask import request from flask_restplus import Namespace, Resource, cors from auth_api","ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message': 'Not authorized to","request body.\"\"\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format:","request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message':","© 2019 Province of British Columbia # # Licensed under the Apache License,","new product subscription to the org using the request body.\"\"\" request_json = request.get_json()","# Copyright © 2019 Province of British Columbia # # Licensed under the","ANY KIND, either express or implied. # See the License for the specific","import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import","from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import","auth_api.schemas import utils as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer","_JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing","@TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product subscription to the org","except BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code return","import utils as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import","an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either","in compliance with the License. # You may obtain a copy of the","{'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response,","License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or","product subscription to the org using the request body.\"\"\" request_json = request.get_json() valid_format,","'Not authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions':","# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #","post(org_id): \"\"\"Post a new product subscription to the org using the request body.\"\"\"","use this file except in compliance with the License. # You may obtain","at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed","http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code","as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code return response, status","many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code, 'message':","from auth_api import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import","(the 'License'); # you may not use this file except in compliance with","not use this file except in compliance with the License. # You may","as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import","WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See","'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json)","http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as","response, status = {'message': 'Not authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else:","Resource, cors from auth_api import status as http_status from auth_api.exceptions import BusinessException from","See the License for the specific language governing permissions and # limitations under","ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code,","BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.","\"\"\"API endpoints for managing an Org resource.\"\"\" from flask import request from flask_restplus","import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products',","schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status","import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from","from flask_restplus import Namespace, Resource, cors from auth_api import status as http_status from","auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils","License, Version 2.0 (the 'License'); # you may not use this file except","a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required","None: response, status = {'message': 'Not authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED","= {'message': 'Not authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status","2019 Province of British Columbia # # Licensed under the Apache License, Version","cors from auth_api import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper","# http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in","writing, software # distributed under the License is distributed on an 'AS IS'","under the License. \"\"\"API endpoints for managing an Org resource.\"\"\" from flask import","org using the request body.\"\"\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription')","ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import Product as ProductService","OF ANY KIND, either express or implied. # See the License for the","limitations under the License. \"\"\"API endpoints for managing an Org resource.\"\"\" from flask","status = {'message': 'Not authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response,","from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API","from flask import request from flask_restplus import Namespace, Resource, cors from auth_api import","@staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product subscription to the","of British Columbia # # Licensed under the Apache License, Version 2.0 (the","to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)},","status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status","not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions","# you may not use this file except in compliance with the License.","subscriptions is None: response, status = {'message': 'Not authorized to perform this action'},","@cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod","\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message},","agreed to in writing, software # distributed under the License is distributed on","valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try:","{'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code':","= {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status =","= schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions =","= ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message': 'Not authorized","WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the","OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post","subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message': 'Not","# distributed under the License is distributed on an 'AS IS' BASIS, #","from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from","for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST',","distributed under the License is distributed on an 'AS IS' BASIS, # WITHOUT","if subscriptions is None: response, status = {'message': 'Not authorized to perform this","# Licensed under the Apache License, Version 2.0 (the 'License'); # you may","schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles","IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or","auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API =","from auth_api.schemas import utils as schema_utils from auth_api.services import Product as ProductService from","# # Unless required by applicable law or agreed to in writing, software","Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints","import Namespace, Resource, cors from auth_api import status as http_status from auth_api.exceptions import","auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products","the Apache License, Version 2.0 (the 'License'); # you may not use this","express or implied. # See the License for the specific language governing permissions","import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import Product as","from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for","# Unless required by applicable law or agreed to in writing, software #","def post(org_id): \"\"\"Post a new product subscription to the org using the request","except in compliance with the License. # You may obtain a copy of","utils as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import Tracer","to the org using the request body.\"\"\" request_json = request.get_json() valid_format, errors =","by applicable law or agreed to in writing, software # distributed under the","is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF","request from flask_restplus import Namespace, Resource, cors from auth_api import status as http_status","return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None:","flask_restplus import Namespace, Resource, cors from auth_api import status as http_status from auth_api.exceptions","TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource):","copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by","this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED","'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express","@cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product subscription to the org using","either express or implied. # See the License for the specific language governing","managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product","# You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0","may not use this file except in compliance with the License. # You","governing permissions and # limitations under the License. \"\"\"API endpoints for managing an","# limitations under the License. \"\"\"API endpoints for managing an Org resource.\"\"\" from","BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code return response,","import request from flask_restplus import Namespace, Resource, cors from auth_api import status as","http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema","request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST","# # Licensed under the Apache License, Version 2.0 (the 'License'); # you","# # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to","<gh_stars>0 # Copyright © 2019 Province of British Columbia # # Licensed under","from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER =","Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util","= Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource","file except in compliance with the License. # You may obtain a copy","the License is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR","status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas","errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions","using the request body.\"\"\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if","try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message':","BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils","@API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace()","auth_api.services import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role","as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import","on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,","subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product subscription to","software # distributed under the License is distributed on an 'AS IS' BASIS,","a new product subscription to the org using the request body.\"\"\" request_json =","= request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)},","License for the specific language governing permissions and # limitations under the License.","for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new","the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law","the specific language governing permissions and # limitations under the License. \"\"\"API endpoints","permissions and # limitations under the License. \"\"\"API endpoints for managing an Org","if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if","action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except","description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET',","the License. # You may obtain a copy of the License at #","JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services","from auth_api.services import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import","License. \"\"\"API endpoints for managing an Org resource.\"\"\" from flask import request from","Copyright © 2019 Province of British Columbia # # Licensed under the Apache","Columbia # # Licensed under the Apache License, Version 2.0 (the 'License'); #","to in writing, software # distributed under the License is distributed on an","from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as","for the specific language governing permissions and # limitations under the License. \"\"\"API","implied. # See the License for the specific language governing permissions and #","language governing permissions and # limitations under the License. \"\"\"API endpoints for managing","Org resource.\"\"\" from flask import request from flask_restplus import Namespace, Resource, cors from","{'message': 'Not authorized to perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status =","obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless","http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status =","required by applicable law or agreed to in writing, software # distributed under","Version 2.0 (the 'License'); # you may not use this file except in","an Org resource.\"\"\" from flask import request from flask_restplus import Namespace, Resource, cors","body.\"\"\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return","perform this action'}, \\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\","applicable law or agreed to in writing, software # distributed under the License","class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id):","auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas","under the License is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES","methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*')","\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException","flask import request from flask_restplus import Namespace, Resource, cors from auth_api import status","for managing an Org resource.\"\"\" from flask import request from flask_restplus import Namespace,","is None: response, status = {'message': 'Not authorized to perform this action'}, \\","or agreed to in writing, software # distributed under the License is distributed","\"\"\"Post a new product subscription to the org using the request body.\"\"\" request_json","or implied. # See the License for the specific language governing permissions and","import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from","'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def","response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\ http_status.HTTP_201_CREATED except BusinessException as exception: response,","as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import Tracer from","2.0 (the 'License'); # you may not use this file except in compliance","CONDITIONS OF ANY KIND, either express or implied. # See the License for","JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\"","API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance()","OR CONDITIONS OF ANY KIND, either express or implied. # See the License","may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # #","the request body.\"\"\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not","cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT =","in writing, software # distributed under the License is distributed on an 'AS","'POST', 'OPTIONS']) class OrgProducts(Resource): \"\"\"Resource for managing product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value])","with the License. # You may obtain a copy of the License at","request_json) if subscriptions is None: response, status = {'message': 'Not authorized to perform","http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing,","and # limitations under the License. \"\"\"API endpoints for managing an Org resource.\"\"\"","subscription to the org using the request body.\"\"\" request_json = request.get_json() valid_format, errors","License is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS","Namespace, Resource, cors from auth_api import status as http_status from auth_api.exceptions import BusinessException","product subscriptions.\"\"\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \"\"\"Post a new product subscription"],"string":"[\n \"auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance()\",\n \"endpoints for managing an Org resource.\\\"\\\"\\\" from flask import request from flask_restplus import\",\n \"Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('',\",\n \"KIND, either express or implied. # See the License for the specific language\",\n \"schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id,\",\n \"Unless required by applicable law or agreed to in writing, software # distributed\",\n \"You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 #\",\n \"# See the License for the specific language governing permissions and # limitations\",\n \"Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for\",\n \"specific language governing permissions and # limitations under the License. \\\"\\\"\\\"API endpoints for\",\n \"License. # You may obtain a copy of the License at # #\",\n \"auth_api import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper\",\n \"management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class\",\n \"valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is\",\n \"= Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS')\",\n \"import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management')\",\n \"distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY\",\n \"else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception:\",\n \"'License'); # you may not use this file except in compliance with the\",\n \"the License. \\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\" from flask import request\",\n \"law or agreed to in writing, software # distributed under the License is\",\n \"auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import Product\",\n \"= JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product\",\n \"the License for the specific language governing permissions and # limitations under the\",\n \"Apache License, Version 2.0 (the 'License'); # you may not use this file\",\n \"compliance with the License. # You may obtain a copy of the License\",\n \"import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from\",\n \"the org using the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json,\",\n \"Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER\",\n \"@_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product subscription to the org using the\",\n \"authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions,\",\n \"Province of British Columbia # # Licensed under the Apache License, Version 2.0\",\n \"Licensed under the Apache License, Version 2.0 (the 'License'); # you may not\",\n \"this file except in compliance with the License. # You may obtain a\",\n \"products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS'])\",\n \"import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT\",\n \"under the Apache License, Version 2.0 (the 'License'); # you may not use\",\n \"managing an Org resource.\\\"\\\"\\\" from flask import request from flask_restplus import Namespace, Resource,\",\n \"you may not use this file except in compliance with the License. #\",\n \"British Columbia # # Licensed under the Apache License, Version 2.0 (the 'License');\",\n \"of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable\",\n \"ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight\",\n \"\\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a\",\n \"resource.\\\"\\\"\\\" from flask import request from flask_restplus import Namespace, Resource, cors from auth_api\",\n \"ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message': 'Not authorized to\",\n \"request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format:\",\n \"request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message':\",\n \"© 2019 Province of British Columbia # # Licensed under the Apache License,\",\n \"new product subscription to the org using the request body.\\\"\\\"\\\" request_json = request.get_json()\",\n \"# Copyright © 2019 Province of British Columbia # # Licensed under the\",\n \"ANY KIND, either express or implied. # See the License for the specific\",\n \"import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import\",\n \"from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import\",\n \"auth_api.schemas import utils as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer\",\n \"_JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing\",\n \"@TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product subscription to the org\",\n \"except BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code return\",\n \"import utils as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import\",\n \"an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either\",\n \"in compliance with the License. # You may obtain a copy of the\",\n \"{'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response,\",\n \"License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or\",\n \"product subscription to the org using the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format,\",\n \"'Not authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions':\",\n \"# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #\",\n \"post(org_id): \\\"\\\"\\\"Post a new product subscription to the org using the request body.\\\"\\\"\\\"\",\n \"use this file except in compliance with the License. # You may obtain\",\n \"at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed\",\n \"http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code\",\n \"as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code return response, status\",\n \"many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code, 'message':\",\n \"from auth_api import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import\",\n \"(the 'License'); # you may not use this file except in compliance with\",\n \"not use this file except in compliance with the License. # You may\",\n \"as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import\",\n \"WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See\",\n \"'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json)\",\n \"http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as\",\n \"response, status = {'message': 'Not authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else:\",\n \"Resource, cors from auth_api import status as http_status from auth_api.exceptions import BusinessException from\",\n \"See the License for the specific language governing permissions and # limitations under\",\n \"ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code,\",\n \"BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\",\n \"\\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\" from flask import request from flask_restplus\",\n \"import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products',\",\n \"schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status\",\n \"import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from\",\n \"from flask_restplus import Namespace, Resource, cors from auth_api import status as http_status from\",\n \"auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils\",\n \"License, Version 2.0 (the 'License'); # you may not use this file except\",\n \"a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required\",\n \"None: response, status = {'message': 'Not authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED\",\n \"= {'message': 'Not authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status\",\n \"2019 Province of British Columbia # # Licensed under the Apache License, Version\",\n \"cors from auth_api import status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper\",\n \"# http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in\",\n \"writing, software # distributed under the License is distributed on an 'AS IS'\",\n \"under the License. \\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\" from flask import\",\n \"org using the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription')\",\n \"ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import Product as ProductService\",\n \"OF ANY KIND, either express or implied. # See the License for the\",\n \"limitations under the License. \\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\" from flask\",\n \"status = {'message': 'Not authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response,\",\n \"from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API\",\n \"from flask import request from flask_restplus import Namespace, Resource, cors from auth_api import\",\n \"@staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product subscription to the\",\n \"of British Columbia # # Licensed under the Apache License, Version 2.0 (the\",\n \"to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)},\",\n \"status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status\",\n \"not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions\",\n \"# you may not use this file except in compliance with the License.\",\n \"subscriptions is None: response, status = {'message': 'Not authorized to perform this action'},\",\n \"@cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod\",\n \"\\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message},\",\n \"agreed to in writing, software # distributed under the License is distributed on\",\n \"valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try:\",\n \"{'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status = {'code':\",\n \"= {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response, status =\",\n \"= schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions =\",\n \"= ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message': 'Not authorized\",\n \"WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the\",\n \"OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post\",\n \"subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message': 'Not\",\n \"# distributed under the License is distributed on an 'AS IS' BASIS, #\",\n \"from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from\",\n \"for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST',\",\n \"distributed under the License is distributed on an 'AS IS' BASIS, # WITHOUT\",\n \"if subscriptions is None: response, status = {'message': 'Not authorized to perform this\",\n \"# Licensed under the Apache License, Version 2.0 (the 'License'); # you may\",\n \"schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles\",\n \"IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\",\n \"auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API =\",\n \"from auth_api.schemas import utils as schema_utils from auth_api.services import Product as ProductService from\",\n \"# # Unless required by applicable law or agreed to in writing, software\",\n \"Tracer from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints\",\n \"import Namespace, Resource, cors from auth_api import status as http_status from auth_api.exceptions import\",\n \"auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products\",\n \"the Apache License, Version 2.0 (the 'License'); # you may not use this\",\n \"express or implied. # See the License for the specific language governing permissions\",\n \"import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services import Product as\",\n \"from auth_api.utils.roles import Role from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for\",\n \"# Unless required by applicable law or agreed to in writing, software #\",\n \"def post(org_id): \\\"\\\"\\\"Post a new product subscription to the org using the request\",\n \"except in compliance with the License. # You may obtain a copy of\",\n \"utils as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import Tracer\",\n \"to the org using the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors =\",\n \"by applicable law or agreed to in writing, software # distributed under the\",\n \"is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF\",\n \"request from flask_restplus import Namespace, Resource, cors from auth_api import status as http_status\",\n \"return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None:\",\n \"flask_restplus import Namespace, Resource, cors from auth_api import status as http_status from auth_api.exceptions\",\n \"TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource):\",\n \"copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by\",\n \"this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED\",\n \"'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express\",\n \"@cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product subscription to the org using\",\n \"either express or implied. # See the License for the specific language governing\",\n \"managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product\",\n \"# You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0\",\n \"may not use this file except in compliance with the License. # You\",\n \"governing permissions and # limitations under the License. \\\"\\\"\\\"API endpoints for managing an\",\n \"# limitations under the License. \\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\" from\",\n \"BusinessException as exception: response, status = {'code': exception.code, 'message': exception.message}, exception.status_code return response,\",\n \"import request from flask_restplus import Namespace, Resource, cors from auth_api import status as\",\n \"http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema\",\n \"request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST\",\n \"# # Licensed under the Apache License, Version 2.0 (the 'License'); # you\",\n \"# # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to\",\n \"<gh_stars>0 # Copyright © 2019 Province of British Columbia # # Licensed under\",\n \"from auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER =\",\n \"Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util\",\n \"= Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource\",\n \"file except in compliance with the License. # You may obtain a copy\",\n \"the License is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR\",\n \"status as http_status from auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas\",\n \"errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions\",\n \"using the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if\",\n \"try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status = {'message':\",\n \"BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils\",\n \"@API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace()\",\n \"auth_api.services import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role\",\n \"as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from auth_api.utils.util import\",\n \"on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,\",\n \"subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product subscription to\",\n \"software # distributed under the License is distributed on an 'AS IS' BASIS,\",\n \"a new product subscription to the org using the request body.\\\"\\\"\\\" request_json =\",\n \"= request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return {'message': schema_utils.serialize(errors)},\",\n \"License for the specific language governing permissions and # limitations under the License.\",\n \"for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new\",\n \"the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law\",\n \"the specific language governing permissions and # limitations under the License. \\\"\\\"\\\"API endpoints\",\n \"permissions and # limitations under the License. \\\"\\\"\\\"API endpoints for managing an Org\",\n \"if not valid_format: return {'message': schema_utils.serialize(errors)}, http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if\",\n \"action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except\",\n \"description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET',\",\n \"the License. # You may obtain a copy of the License at #\",\n \"JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as schema_utils from auth_api.services\",\n \"from auth_api.services import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import\",\n \"License. \\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\" from flask import request from\",\n \"Copyright © 2019 Province of British Columbia # # Licensed under the Apache\",\n \"Columbia # # Licensed under the Apache License, Version 2.0 (the 'License'); #\",\n \"to in writing, software # distributed under the License is distributed on an\",\n \"from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas import utils as\",\n \"for the specific language governing permissions and # limitations under the License. \\\"\\\"\\\"API\",\n \"implied. # See the License for the specific language governing permissions and #\",\n \"language governing permissions and # limitations under the License. \\\"\\\"\\\"API endpoints for managing\",\n \"Org resource.\\\"\\\"\\\" from flask import request from flask_restplus import Namespace, Resource, cors from\",\n \"{'message': 'Not authorized to perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status =\",\n \"obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless\",\n \"http_status.HTTP_400_BAD_REQUEST try: subscriptions = ProductService.create_product_subscription(org_id, request_json) if subscriptions is None: response, status =\",\n \"required by applicable law or agreed to in writing, software # distributed under\",\n \"Version 2.0 (the 'License'); # you may not use this file except in\",\n \"an Org resource.\\\"\\\"\\\" from flask import request from flask_restplus import Namespace, Resource, cors\",\n \"body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not valid_format: return\",\n \"perform this action'}, \\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\\",\n \"applicable law or agreed to in writing, software # distributed under the License\",\n \"class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id):\",\n \"auth_api.exceptions import BusinessException from auth_api.jwt_wrapper import JWTWrapper from auth_api.schemas import ProductSubscriptionSchema from auth_api.schemas\",\n \"under the License is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES\",\n \"methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*')\",\n \"\\\\ http_status.HTTP_401_UNAUTHORIZED else: response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException\",\n \"flask import request from flask_restplus import Namespace, Resource, cors from auth_api import status\",\n \"for managing an Org resource.\\\"\\\"\\\" from flask import request from flask_restplus import Namespace,\",\n \"is None: response, status = {'message': 'Not authorized to perform this action'}, \\\\\",\n \"or agreed to in writing, software # distributed under the License is distributed\",\n \"\\\"\\\"\\\"Post a new product subscription to the org using the request body.\\\"\\\"\\\" request_json\",\n \"or implied. # See the License for the specific language governing permissions and\",\n \"import Product as ProductService from auth_api.tracer import Tracer from auth_api.utils.roles import Role from\",\n \"'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def\",\n \"response, status = {'subscriptions': ProductSubscriptionSchema().dump(subscriptions, many=True)}, \\\\ http_status.HTTP_201_CREATED except BusinessException as exception: response,\",\n \"as schema_utils from auth_api.services import Product as ProductService from auth_api.tracer import Tracer from\",\n \"2.0 (the 'License'); # you may not use this file except in compliance\",\n \"CONDITIONS OF ANY KIND, either express or implied. # See the License for\",\n \"JWTWrapper.get_instance() @cors_preflight('GET,POST,OPTIONS') @API.route('', methods=['GET', 'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\"\",\n \"API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT = JWTWrapper.get_instance()\",\n \"OR CONDITIONS OF ANY KIND, either express or implied. # See the License\",\n \"may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # #\",\n \"the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors = schema_utils.validate(request_json, 'org_product_subscription') if not\",\n \"cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance() _JWT =\",\n \"in writing, software # distributed under the License is distributed on an 'AS\",\n \"'POST', 'OPTIONS']) class OrgProducts(Resource): \\\"\\\"\\\"Resource for managing product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value])\",\n \"with the License. # You may obtain a copy of the License at\",\n \"request_json) if subscriptions is None: response, status = {'message': 'Not authorized to perform\",\n \"http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing,\",\n \"and # limitations under the License. \\\"\\\"\\\"API endpoints for managing an Org resource.\\\"\\\"\\\"\",\n \"subscription to the org using the request body.\\\"\\\"\\\" request_json = request.get_json() valid_format, errors\",\n \"License is distributed on an 'AS IS' BASIS, # WITHOUT WARRANTIES OR CONDITIONS\",\n \"Namespace, Resource, cors from auth_api import status as http_status from auth_api.exceptions import BusinessException\",\n \"product subscriptions.\\\"\\\"\\\" @staticmethod @TRACER.trace() @cors.crossdomain(origin='*') @_JWT.has_one_of_roles([Role.STAFF_CREATE_ACCOUNTS.value]) def post(org_id): \\\"\\\"\\\"Post a new product subscription\"\n]","isConversational":false}}},{"rowIdx":274,"cells":{"ngram":{"kind":"list like","value":[").count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor","import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import","class Command(BaseCommand): def handle(self, *args, **options): # This is not DRY. Originally, this","deduplicated dict of coordinators from the pending app queryset, along # with a","Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated dict","status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does","TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So, we did a","( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION)","all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0])","with a status of PENDING or QUESTION # or APPROVED, and their corresponding","try: # We create a dictionary with the three status codes # we'd","with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) &","editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0]) )","TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def","Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class","\"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in list(coordinators.items()): try: # We create a","of coordinators from the pending app queryset, along # with a count of","} editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0])","pending apps they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) )","Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor","= Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in list(coordinators.items()):","# TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So, we did","and their corresponding user preferences being True # for partners with a status","app queryset, along # with a count of how many total pending apps","they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator,",".order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated dict of coordinators from the pending","Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder","of PENDING or QUESTION # or APPROVED, and their corresponding user preferences being","\"partner\", \"date_created\") ) # A deduplicated dict of coordinators from the pending app","from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So, we","Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is","Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor =","# We're actually getting apps with a status of PENDING or QUESTION #","to send emails for, and their corresponding # counts. app_status_and_count = { Application.PENDING:","did a copy/paste. # We're actually getting apps with a status of PENDING","of how many total pending apps they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\",","Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") )","a status of PENDING or QUESTION # or APPROVED, and their corresponding user","all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {}","bother with the signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send(","status of PENDING or QUESTION # or APPROVED, and their corresponding user preferences","or APPROVED, and their corresponding user preferences being True # for partners with","& Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\",","{} does not exist; skipping.\".format(coordinator[0]) ) break # Only bother with the signal","getting apps with a status of PENDING or QUESTION # or APPROVED, and","\"date_created\") ) # A deduplicated dict of coordinators from the pending app queryset,","all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True )","So, we did a copy/paste. # We're actually getting apps with a status","import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This","= ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) &","with the signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__,","status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) |","coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in","from collections import Counter from django.core.management.base import BaseCommand from django.db.models import Q from","django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals","import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import","partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True","partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated dict of","the pending app queryset, along # with a count of how many total","queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So,","if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username, coordinator_email=coordinator[1],","corresponding user preferences being True # for partners with a status of AVAILABLE.","all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in list(coordinators.items()): try: #","def handle(self, *args, **options): # This is not DRY. Originally, this pulled the","\"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in list(coordinators.items()): try: # We","a count of how many total pending apps they have coordinators = Counter(","logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is not","\"Editor {} does not exist; skipping.\".format(coordinator[0]) ) break # Only bother with the","partners with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True )","*args, **options): # This is not DRY. Originally, this pulled the queryset from","the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object.","Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects",").count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does not exist;","AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True","now expects a request object. So, we did a copy/paste. # We're actually","# We create a dictionary with the three status codes # we'd want","have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count","app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(),","from the pending app queryset, along # with a count of how many","= { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED:","django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models","along # with a count of how many total pending apps they have",") # A deduplicated dict of coordinators from the pending app queryset, along","how many total pending apps they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\",","total pending apps they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", )","collections import Counter from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models","TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): #","QUESTION # or APPROVED, and their corresponding user preferences being True # for","many total pending apps they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\",","dictionary with the three status codes # we'd want to send emails for,","status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except","skipping.\".format(coordinator[0]) ) break # Only bother with the signal if we have a","Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\",","= Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0]) ) break","PENDING or QUESTION # or APPROVED, and their corresponding user preferences being True","partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) #","this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a","a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING)","object. So, we did a copy/paste. # We're actually getting apps with a","# But that now expects a request object. So, we did a copy/paste.","create a dictionary with the three status codes # we'd want to send","copy/paste. # We're actually getting apps with a status of PENDING or QUESTION","with a count of how many total pending apps they have coordinators =","we'd want to send emails for, and their corresponding # counts. app_status_and_count =","# or APPROVED, and their corresponding user preferences being True # for partners","user preferences being True # for partners with a status of AVAILABLE. all_apps","in list(coordinators.items()): try: # We create a dictionary with the three status codes","dict of coordinators from the pending app queryset, along # with a count","a request object. So, we did a copy/paste. # We're actually getting apps","Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED),","we did a copy/paste. # We're actually getting apps with a status of","partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does not",") .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated dict of coordinators from","the three status codes # we'd want to send emails for, and their","apps with a status of PENDING or QUESTION # or APPROVED, and their","of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q(",") & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\")","Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q(","# we'd want to send emails for, and their corresponding # counts. app_status_and_count","all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0],","import Counter from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import","Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor","emails for, and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING,","three status codes # we'd want to send emails for, and their corresponding","from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger","coordinator, count in list(coordinators.items()): try: # We create a dictionary with the three","corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter(","list(coordinators.items()): try: # We create a dictionary with the three status codes #","DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now","| Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE],","have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username, coordinator_email=coordinator[1], coordinator_lang=coordinator[2], )","queryset, along # with a count of how many total pending apps they","not exist; skipping.\".format(coordinator[0]) ) break # Only bother with the signal if we","handle(self, *args, **options): # This is not DRY. Originally, this pulled the queryset","# for partners with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q(","Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) |",") break # Only bother with the signal if we have a coordinator","or QUESTION # or APPROVED, and their corresponding user preferences being True #","pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request","status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(),","Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0]) ) break #","A deduplicated dict of coordinators from the pending app queryset, along # with","from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from","that now expects a request object. So, we did a copy/paste. # We're","Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False,","actually getting apps with a status of PENDING or QUESTION # or APPROVED,","being True # for partners with a status of AVAILABLE. all_apps = (","for partners with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True","break # Only bother with the signal if we have a coordinator email.","signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username,","import logging from collections import Counter from django.core.management.base import BaseCommand from django.db.models import","for coordinator, count in list(coordinators.items()): try: # We create a dictionary with the","# This is not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset().","except Editor.DoesNotExist: logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0]) ) break # Only",") ) for coordinator, count in list(coordinators.items()): try: # We create a dictionary","the signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count,","logging from collections import Counter from django.core.management.base import BaseCommand from django.db.models import Q","request object. So, we did a copy/paste. # We're actually getting apps with","Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED,","editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated dict of coordinators","import BaseCommand from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import","not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that","import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self,","{ Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter(","import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__)","a copy/paste. # We're actually getting apps with a status of PENDING or",").count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info(",") & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A",".exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated dict of coordinators from the","**options): # This is not DRY. Originally, this pulled the queryset from #","= logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is not DRY.","# with a count of how many total pending apps they have coordinators","exist; skipping.\".format(coordinator[0]) ) break # Only bother with the signal if we have","We're actually getting apps with a status of PENDING or QUESTION # or","send emails for, and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter(","their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION:","partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist:","Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args,","from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from","& Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) &","# counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION,",") for coordinator, count in list(coordinators.items()): try: # We create a dictionary with","logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is not DRY. Originally,","Editor.DoesNotExist: logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0]) ) break # Only bother","We create a dictionary with the three status codes # we'd want to","their corresponding user preferences being True # for partners with a status of","But that now expects a request object. So, we did a copy/paste. #","does not exist; skipping.\".format(coordinator[0]) ) break # Only bother with the signal if","and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(),","partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), }","# Only bother with the signal if we have a coordinator email. if","preferences being True # for partners with a status of AVAILABLE. all_apps =","logger.info( \"Editor {} does not exist; skipping.\".format(coordinator[0]) ) break # Only bother with","a dictionary with the three status codes # we'd want to send emails","we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username, coordinator_email=coordinator[1], coordinator_lang=coordinator[2],","counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0],","for, and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0],","TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger =","count in list(coordinators.items()): try: # We create a dictionary with the three status",") & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True )","True # for partners with a status of AVAILABLE. all_apps = ( Application.objects.filter(","# A deduplicated dict of coordinators from the pending app queryset, along #","from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options):","from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import Application from","BaseCommand from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner","TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models","APPROVED, and their corresponding user preferences being True # for partners with a","from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand):","count of how many total pending apps they have coordinators = Counter( all_apps.values_list(","Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in list(coordinators.items()): try:","status codes # we'd want to send emails for, and their corresponding #","partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, )","want to send emails for, and their corresponding # counts. app_status_and_count = {","apps they have coordinators = Counter( all_apps.values_list( \"partner__coordinator__editor\", \"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for","coordinators from the pending app queryset, along # with a count of how","with the three status codes # we'd want to send emails for, and","expects a request object. So, we did a copy/paste. # We're actually getting","& Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\") ) # A deduplicated","\"partner__coordinator__email\", \"partner__coordinator__editor__user__userprofile__lang\", ) ) for coordinator, count in list(coordinators.items()): try: # We create","is not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But","Only bother with the signal if we have a coordinator email. if coordinator[1]:","Counter from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import Application","codes # we'd want to send emails for, and their corresponding # counts.","This is not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). #","| Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\"restricted\") .order_by(\"status\", \"partner\", \"date_created\")","pending app queryset, along # with a count of how many total pending","Command(BaseCommand): def handle(self, *args, **options): # This is not DRY. Originally, this pulled"],"string":"[\n \").count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor\",\n \"import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import\",\n \"class Command(BaseCommand): def handle(self, *args, **options): # This is not DRY. Originally, this\",\n \"deduplicated dict of coordinators from the pending app queryset, along # with a\",\n \"Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict\",\n \"status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does\",\n \"TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So, we did a\",\n \"( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION)\",\n \"all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0])\",\n \"with a status of PENDING or QUESTION # or APPROVED, and their corresponding\",\n \"try: # We create a dictionary with the three status codes # we'd\",\n \"with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) &\",\n \"editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) )\",\n \"TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def\",\n \"Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class\",\n \"\\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in list(coordinators.items()): try: # We create a\",\n \"of coordinators from the pending app queryset, along # with a count of\",\n \"} editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0])\",\n \"pending apps they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) )\",\n \"Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor\",\n \"= Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in list(coordinators.items()):\",\n \"# TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So, we did\",\n \"and their corresponding user preferences being True # for partners with a status\",\n \"app queryset, along # with a count of how many total pending apps\",\n \"they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator,\",\n \".order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict of coordinators from the pending\",\n \"Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder\",\n \"of PENDING or QUESTION # or APPROVED, and their corresponding user preferences being\",\n \"\\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict of coordinators from the pending app\",\n \"from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So, we\",\n \"Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is\",\n \"Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor =\",\n \"# We're actually getting apps with a status of PENDING or QUESTION #\",\n \"to send emails for, and their corresponding # counts. app_status_and_count = { Application.PENDING:\",\n \"did a copy/paste. # We're actually getting apps with a status of PENDING\",\n \"of how many total pending apps they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\",\",\n \"Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") )\",\n \"a status of PENDING or QUESTION # or APPROVED, and their corresponding user\",\n \"all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {}\",\n \"bother with the signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send(\",\n \"status of PENDING or QUESTION # or APPROVED, and their corresponding user preferences\",\n \"or APPROVED, and their corresponding user preferences being True # for partners with\",\n \"& Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\",\",\n \"{} does not exist; skipping.\\\".format(coordinator[0]) ) break # Only bother with the signal\",\n \"getting apps with a status of PENDING or QUESTION # or APPROVED, and\",\n \"\\\"date_created\\\") ) # A deduplicated dict of coordinators from the pending app queryset,\",\n \"all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True )\",\n \"So, we did a copy/paste. # We're actually getting apps with a status\",\n \"import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This\",\n \"= ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) &\",\n \"with the signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__,\",\n \"status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) |\",\n \"coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in\",\n \"from collections import Counter from django.core.management.base import BaseCommand from django.db.models import Q from\",\n \"django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals\",\n \"import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import\",\n \"partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True\",\n \"partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict of\",\n \"the pending app queryset, along # with a count of how many total\",\n \"queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object. So,\",\n \"if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username, coordinator_email=coordinator[1],\",\n \"corresponding user preferences being True # for partners with a status of AVAILABLE.\",\n \"all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in list(coordinators.items()): try: #\",\n \"def handle(self, *args, **options): # This is not DRY. Originally, this pulled the\",\n \"\\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in list(coordinators.items()): try: # We\",\n \"a count of how many total pending apps they have coordinators = Counter(\",\n \"logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is not\",\n \"\\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) ) break # Only bother with the\",\n \"partners with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True )\",\n \"*args, **options): # This is not DRY. Originally, this pulled the queryset from\",\n \"the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request object.\",\n \"Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects\",\n \").count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist;\",\n \"AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True\",\n \"now expects a request object. So, we did a copy/paste. # We're actually\",\n \"# We create a dictionary with the three status codes # we'd want\",\n \"have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count\",\n \"app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(),\",\n \"from the pending app queryset, along # with a count of how many\",\n \"= { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED:\",\n \"django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models\",\n \"along # with a count of how many total pending apps they have\",\n \") # A deduplicated dict of coordinators from the pending app queryset, along\",\n \"how many total pending apps they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\",\",\n \"total pending apps they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", )\",\n \"collections import Counter from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models\",\n \"TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): #\",\n \"QUESTION # or APPROVED, and their corresponding user preferences being True # for\",\n \"many total pending apps they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\",\",\n \"dictionary with the three status codes # we'd want to send emails for,\",\n \"status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except\",\n \"skipping.\\\".format(coordinator[0]) ) break # Only bother with the signal if we have a\",\n \"Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\",\",\n \"= Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) ) break\",\n \"PENDING or QUESTION # or APPROVED, and their corresponding user preferences being True\",\n \"partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) #\",\n \"this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a\",\n \"a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING)\",\n \"object. So, we did a copy/paste. # We're actually getting apps with a\",\n \"# But that now expects a request object. So, we did a copy/paste.\",\n \"create a dictionary with the three status codes # we'd want to send\",\n \"copy/paste. # We're actually getting apps with a status of PENDING or QUESTION\",\n \"with a count of how many total pending apps they have coordinators =\",\n \"we'd want to send emails for, and their corresponding # counts. app_status_and_count =\",\n \"# or APPROVED, and their corresponding user preferences being True # for partners\",\n \"user preferences being True # for partners with a status of AVAILABLE. all_apps\",\n \"in list(coordinators.items()): try: # We create a dictionary with the three status codes\",\n \"dict of coordinators from the pending app queryset, along # with a count\",\n \"a request object. So, we did a copy/paste. # We're actually getting apps\",\n \"Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED),\",\n \"we did a copy/paste. # We're actually getting apps with a status of\",\n \"partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does not\",\n \") .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict of coordinators from\",\n \"the three status codes # we'd want to send emails for, and their\",\n \"apps with a status of PENDING or QUESTION # or APPROVED, and their\",\n \"of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q(\",\n \") & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\")\",\n \"Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q(\",\n \"# we'd want to send emails for, and their corresponding # counts. app_status_and_count\",\n \"all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0],\",\n \"import Counter from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import\",\n \"Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor\",\n \"emails for, and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING,\",\n \"three status codes # we'd want to send emails for, and their corresponding\",\n \"from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger\",\n \"coordinator, count in list(coordinators.items()): try: # We create a dictionary with the three\",\n \"corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter(\",\n \"list(coordinators.items()): try: # We create a dictionary with the three status codes #\",\n \"DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now\",\n \"| Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE],\",\n \"have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username, coordinator_email=coordinator[1], coordinator_lang=coordinator[2], )\",\n \"queryset, along # with a count of how many total pending apps they\",\n \"not exist; skipping.\\\".format(coordinator[0]) ) break # Only bother with the signal if we\",\n \"handle(self, *args, **options): # This is not DRY. Originally, this pulled the queryset\",\n \"# for partners with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q(\",\n \"Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True ) & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) |\",\n \") break # Only bother with the signal if we have a coordinator\",\n \"or QUESTION # or APPROVED, and their corresponding user preferences being True #\",\n \"pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that now expects a request\",\n \"status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(),\",\n \"Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) ) break #\",\n \"A deduplicated dict of coordinators from the pending app queryset, along # with\",\n \"from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner from\",\n \"that now expects a request object. So, we did a copy/paste. # We're\",\n \"Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False,\",\n \"actually getting apps with a status of PENDING or QUESTION # or APPROVED,\",\n \"being True # for partners with a status of AVAILABLE. all_apps = (\",\n \"for partners with a status of AVAILABLE. all_apps = ( Application.objects.filter( Q( partner__coordinator__editor__user__userprofile__pending_app_reminders=True\",\n \"break # Only bother with the signal if we have a coordinator email.\",\n \"signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username,\",\n \"import logging from collections import Counter from django.core.management.base import BaseCommand from django.db.models import\",\n \"for coordinator, count in list(coordinators.items()): try: # We create a dictionary with the\",\n \"# This is not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset().\",\n \"except Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) ) break # Only\",\n \") ) for coordinator, count in list(coordinators.items()): try: # We create a dictionary\",\n \"the signal if we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count,\",\n \"logging from collections import Counter from django.core.management.base import BaseCommand from django.db.models import Q\",\n \"request object. So, we did a copy/paste. # We're actually getting apps with\",\n \"Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED,\",\n \"editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict of coordinators\",\n \"import BaseCommand from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import\",\n \"not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But that\",\n \"import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self,\",\n \"{ Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter(\",\n \"import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__)\",\n \"a copy/paste. # We're actually getting apps with a status of PENDING or\",\n \").count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist: logger.info(\",\n \") & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A\",\n \".exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated dict of coordinators from the\",\n \"**options): # This is not DRY. Originally, this pulled the queryset from #\",\n \"= logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is not DRY.\",\n \"# with a count of how many total pending apps they have coordinators\",\n \"exist; skipping.\\\".format(coordinator[0]) ) break # Only bother with the signal if we have\",\n \"We're actually getting apps with a status of PENDING or QUESTION # or\",\n \"send emails for, and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter(\",\n \"their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION:\",\n \"partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor = Editor.objects.get(id=coordinator[0]) except Editor.DoesNotExist:\",\n \"Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args,\",\n \"from TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from\",\n \"& Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) &\",\n \"# counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION,\",\n \") for coordinator, count in list(coordinators.items()): try: # We create a dictionary with\",\n \"logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options): # This is not DRY. Originally,\",\n \"Editor.DoesNotExist: logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) ) break # Only bother\",\n \"We create a dictionary with the three status codes # we'd want to\",\n \"their corresponding user preferences being True # for partners with a status of\",\n \"But that now expects a request object. So, we did a copy/paste. #\",\n \"does not exist; skipping.\\\".format(coordinator[0]) ) break # Only bother with the signal if\",\n \"and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(),\",\n \"partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), }\",\n \"# Only bother with the signal if we have a coordinator email. if\",\n \"preferences being True # for partners with a status of AVAILABLE. all_apps =\",\n \"logger.info( \\\"Editor {} does not exist; skipping.\\\".format(coordinator[0]) ) break # Only bother with\",\n \"a dictionary with the three status codes # we'd want to send emails\",\n \"we have a coordinator email. if coordinator[1]: Reminder.coordinator_reminder.send( sender=self.__class__, app_status_and_count=app_status_and_count, coordinator_wp_username=editor.wp_username, coordinator_email=coordinator[1], coordinator_lang=coordinator[2],\",\n \"counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0], ).count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0],\",\n \"for, and their corresponding # counts. app_status_and_count = { Application.PENDING: all_apps.filter( status=Application.PENDING, partner__coordinator__editor=coordinator[0],\",\n \"TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger =\",\n \"count in list(coordinators.items()): try: # We create a dictionary with the three status\",\n \") & Q(status=Application.PENDING) | Q( partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True )\",\n \"True # for partners with a status of AVAILABLE. all_apps = ( Application.objects.filter(\",\n \"# A deduplicated dict of coordinators from the pending app queryset, along #\",\n \"from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand): def handle(self, *args, **options):\",\n \"from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import Application from\",\n \"BaseCommand from django.db.models import Q from TWLight.applications.models import Application from TWLight.resources.models import Partner\",\n \"TWLight.applications.models import Application from TWLight.resources.models import Partner from TWLight.applications.signals import Reminder from TWLight.users.models\",\n \"APPROVED, and their corresponding user preferences being True # for partners with a\",\n \"from TWLight.applications.signals import Reminder from TWLight.users.models import Editor logger = logging.getLogger(__name__) class Command(BaseCommand):\",\n \"count of how many total pending apps they have coordinators = Counter( all_apps.values_list(\",\n \"Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in list(coordinators.items()): try:\",\n \"status codes # we'd want to send emails for, and their corresponding #\",\n \"partner__coordinator__editor__user__userprofile__discussion_app_reminders=True ) & Q(status=Application.QUESTION) | Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, )\",\n \"want to send emails for, and their corresponding # counts. app_status_and_count = {\",\n \"apps they have coordinators = Counter( all_apps.values_list( \\\"partner__coordinator__editor\\\", \\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for\",\n \"coordinators from the pending app queryset, along # with a count of how\",\n \"with the three status codes # we'd want to send emails for, and\",\n \"expects a request object. So, we did a copy/paste. # We're actually getting\",\n \"& Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\") ) # A deduplicated\",\n \"\\\"partner__coordinator__email\\\", \\\"partner__coordinator__editor__user__userprofile__lang\\\", ) ) for coordinator, count in list(coordinators.items()): try: # We create\",\n \"is not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). # But\",\n \"Only bother with the signal if we have a coordinator email. if coordinator[1]:\",\n \"Counter from django.core.management.base import BaseCommand from django.db.models import Q from TWLight.applications.models import Application\",\n \"codes # we'd want to send emails for, and their corresponding # counts.\",\n \"This is not DRY. Originally, this pulled the queryset from # TWLight.applications.views.ListApplicationsView.get_queryset(). #\",\n \"| Q( partner__coordinator__editor__user__userprofile__approved_app_reminders=True ) & Q(status=Application.APPROVED), partner__status__in=[Partner.AVAILABLE], editor__isnull=False, ) .exclude(editor__user__groups__name=\\\"restricted\\\") .order_by(\\\"status\\\", \\\"partner\\\", \\\"date_created\\\")\",\n \"pending app queryset, along # with a count of how many total pending\",\n \"Command(BaseCommand): def handle(self, *args, **options): # This is not DRY. Originally, this pulled\"\n]","isConversational":false}}},{"rowIdx":275,"cells":{"ngram":{"kind":"list like","value":["wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength","photon.active = True return photon class RadialSource(object): \"\"\" A point source that emits","Laser is not set.\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\"","= True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw =","= self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw + 1","self.throw = 0 self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def","+ y**2 if s <= 1.0: LOOP = False z = -1. +","should be perpendicular to the plane normal and aligned with the z-axis. For","self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1,","self.throw self.throw = self.throw + 1 # Position of emission phi = np.random.uniform(0.,","self.wavelength photon.active = True return photon class RadialSource(object): \"\"\" A point source that","= np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform =","GLOBAL FRAME. # i.e. this is passed directly to the photon to set","FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This","\"\"\" def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin","point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active","wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength = wavelength","photon.position[2] + boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction =","should have received a copy of the GNU General Public License # along","if s <= 1.0: LOOP = False z = -1. + 2. *","+ 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing","x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform","this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import","(-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent","= spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint =","PointSource(object): \"\"\" A point source that emits randomly in solid angle specified by","thetamax self.throw = 0 self.source_id = \"PointSource_\" + str(id(self)) def photon(self): photon =","length self.width = width # direction is the direction that photons are fired","Set wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength","= (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position","+ np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5","x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) #","= 0 self.source_id = \"RadialSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source","return photon class CylindricalSource(object): \"\"\" A source for photons emitted in a random","FRAME. # i.e. this is passed directly to the photon to set is's","= None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1),","version. # # pvtrace is distributed in the hope that it will be","For this lense an additional z-boost is added (Angle of incidence in z-direction).","angle specified by phimin, ..., thetamax \"\"\" def __init__(self, spectrum = None, wavelength","z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of","= np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission","Cylinder(radius = radius, length = length) self.radius = radius self.length = length self.throw","photon.id = self.throw self.throw = self.throw + 1 return photon class Laser(object): \"\"\"A","self.throw + 1 return photon class Laser(object): \"\"\"A light source that will generate","thetamax self.spacing = spacing self.throw = 0 self.source_id = \"RadialSource_\" + str(id(self)) def","point which is on the surface of the finite plane in it's local","# You should have received a copy of the GNU General Public License","angle self.throw = 0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self): photon =","= angle self.throw = 0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self): photon","\"focussize\". The focus line should be perpendicular to the plane normal and aligned","# Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x =","= np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin ==","with space tolerance given by variable \"focussize\". The focus line should be perpendicular","0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength","3 of the License, or # (at your option) any later version. #","self.source_id = \"RadialSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id","translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon =","= self.throw self.throw = self.throw + 1 return photon class Laser(object): \"\"\"A light","= thetamax self.spacing = spacing self.throw = 0 self.source_id = \"RadialSource_\" + str(id(self))","# i.e. this is passed directly to the photon to set is's direction","self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost =","GNU General Public License as published by # the Free Software Foundation; either","self.source_id = \"LaserSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id","= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \"\"\" A source","local_point = (x, y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform)","\"SimpleSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position =","rotation angle around xy-plane, the transform from +z to the direction of the","None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \"\"\"","random_spherecial_vector(): # This method of calculating isotropic vectors is taken from GNU Scientific","randomly in solid angle specified by phimin, ..., thetamax \"\"\" def __init__(self, spectrum","of calculating isotropic vectors is taken from GNU Scientific Library LOOP = True","length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length,","super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin =","= wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width #","= 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength =","= self.throw + 1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r","+ str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def","self.throw + 1 return photon class PlanarSource(object): \"\"\"A box that emits photons from","self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True","fired out of the plane in the GLOBAL FRAME. # i.e. this is","wavelength assert polarisation != None, \"Polarisation of the Laser is not set.\" self.polarisation","# it under the terms of the GNU General Public License as published","direction that photons are fired out of the plane in the GLOBAL FRAME.","photon.wavelength = self.wavelength return photon class CylindricalSource(object): \"\"\" A source for photons emitted","tf from Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction,","Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum","= (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax =","direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position =","# # pvtrace is distributed in the hope that it will be useful,","= use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self): photon","direction is the direction that photons are fired out of the plane in","spacing self.throw = 0 self.source_id = \"RadialSource_\" + str(id(self)) def photon(self): photon =","+ np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint","np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction =","def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction =","photon class LensSource(object): \"\"\" A source where photons generated in a plane are","additional z-boost is added (Angle of incidence in z-direction). \"\"\" def __init__(self, spectrum","= phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing =","= self.throw self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y","to the photon to set is's direction self.direction = direction self.throw = 0","that emits randomly in solid angle specified by phimin, ..., thetamax \"\"\" def","transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform if meant to","= 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1),","spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin","in a random direction and position inside a cylinder(radius, length) \"\"\" def __init__(self,","direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength =","+ str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw","self.wavelength = wavelength self.shape = Cylinder(radius = radius, length = length) self.radius =","warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #","A point source that emits at discrete angles theta(i) and phi(i) \"\"\" def","self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing","angle around xy-plane, the transform from +z to the direction of the photon","self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\" +","np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction =","local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x,","if self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x =","photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform if","= direction photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:","= 0 self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self,","emitted in a random direction and position inside a cylinder(radius, length) \"\"\" def","self.radius = radius self.length = length self.throw = 0 self.source_id = \"CylindricalSource_\" +","import translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon from Geometry","= self.wavelength return photon class LensSourceAngle(object): \"\"\" A source where photons generated in","np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta)","photon class PointSource(object): \"\"\" A point source that emits randomly in solid angle","def photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction =","True while LOOP: x = -1. + 2. * np.random.uniform() y = -1.","= \"RadialSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id","+ 2. * np.random.uniform() y = -1. + 2. * np.random.uniform() s =","* np.random.uniform() s = x**2 + y**2 if s <= 1.0: LOOP =","-1. + 2. * np.random.uniform() y = -1. + 2. * np.random.uniform() s","+ 1 return photon class PlanarSource(object): \"\"\"A box that emits photons from the","an additional z-boost is added (Angle of incidence in z-direction). \"\"\" def __init__(self,","theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta)","= transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw = self.throw","z-axis. For this lense an additional z-boost is added (Angle of incidence in","= 0 self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self,","program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix,","LensSource(object): \"\"\" A source where photons generated in a plane are focused on","for more details. # # You should have received a copy of the","translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon from Geometry import","= transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform if meant","self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \"\"\" A source where","position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0","2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength","of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU","photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \"\"\" A source where photons generated","= 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius","def photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw + 1","= intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing","(normal), sampled from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource,","self.throw = self.throw + 1 # Create a point which is on the","source that emits randomly in solid angle specified by phimin, ..., thetamax \"\"\"","s a = 2 * np.sqrt(1 - s) x = a * x","or # (at your option) any later version. # # pvtrace is distributed","!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object):","photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \"\"\" A","self.throw + 1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r =","of the photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R","(0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi):","Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True","y = -1. + 2. * np.random.uniform() s = x**2 + y**2 if","Scientific Library LOOP = True while LOOP: x = -1. + 2. *","photon.id = self.throw self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0])","tolerance given by variable \"focussize\". The focus line should be perpendicular to the","np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else:","Randomise rotation angle around xy-plane, the transform from +z to the direction of","0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength","= self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi","self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from +z to the","of the GNU General Public License as published by # the Free Software","np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the direciton photon.position =","\"\"\" A point source that emits at discrete angles theta(i) and phi(i) \"\"\"","!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active","Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True","translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon()","self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus =","= (x,y,z) photon.direction = local_direction # Set wavelength of photon if self.spectrum !=","inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z)","the direction of the photon vec = random_spherecial_vector() vec[2] = 0. vec =","photon = Photon() photon.id = self.throw self.throw = self.throw + 1 # Position","= 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__()","self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position of emission","a * x y = a * y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A","= phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw =","self.shape = Cylinder(radius = radius, length = length) self.radius = radius self.length =","+ 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2])","later version. # # pvtrace is distributed in the hope that it will","= direction self.throw = 0 self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self, translation):","phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta =","theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction","meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta)","photon.direction = local_direction # Set wavelength of photon if self.spectrum != None: photon.wavelength","transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position = point","received a copy of the GNU General Public License # along with this","Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector():","\"\"\"A box that emits photons from the top surface (normal), sampled from the","by # the Free Software Foundation; either version 3 of the License, or","2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum","= wavelength self.center = center self.phimin = phimin self.phimax = phimax self.thetamin =","copy of the GNU General Public License # along with this program. If","the photon to set is's direction self.direction = direction self.throw = 0 self.source_id","\"\"\" A source where photons generated in a plane are focused on a","import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from","LOOP = False z = -1. + 2. * s a = 2","= self.direction photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:","class CylindricalSource(object): \"\"\" A source for photons emitted in a random direction and","axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw","str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self):","self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0 self.source_id","photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw","= None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0,","self.throw + 1 # Create a point which is on the surface of","self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw + 1 return","self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis):","photon.wavelength = self.wavelength return photon class LensSource(object): \"\"\" A source where photons generated","is distributed in the hope that it will be useful, # but WITHOUT","in it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point","MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public","random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation =","in the hope that it will be useful, # but WITHOUT ANY WARRANTY;","= (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength","class SimpleSource(object): \"\"\"A light source that will generate photons of a single colour,","from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum","FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for","License, or # (at your option) any later version. # # pvtrace is","= thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id =","555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent","= np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id =","+ str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def","# Direction of emission (no need to transform if meant to be isotropic)","if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon","Materials import Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors is","= local_direction # Set wavelength of photon if self.spectrum != None: photon.wavelength =","angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle,","initialisation photon.active = True return photon class PointSource(object): \"\"\" A point source that","intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin","can redistribute it and/or modify # it under the terms of the GNU","+ 1 return photon class Laser(object): \"\"\"A light source that will generate photons","version 3 of the License, or # (at your option) any later version.","None, \"Polarisation of the Laser is not set.\" self.polarisation = np.array(polarisation) self.throw =","-1. + 2. * np.random.uniform() s = x**2 + y**2 if s <=","def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon","= np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If","self.wavelength # If use_polarisation is set generate a random polarisation vector of the","= np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost","radius self.length = length self.throw = 0 self.source_id = \"CylindricalSource_\" + str(id(self)) def","phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum =","of the GNU General Public License # along with this program. If not,","2. * s a = 2 * np.sqrt(1 - s) x = a","License for more details. # # You should have received a copy of","length = length) self.radius = radius self.length = length self.throw = 0 self.source_id","rotation_matrix import external.transformations as tf from Trace import Photon from Geometry import Box,","* y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that will generate photons","= np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction","redistribute it and/or modify # it under the terms of the GNU General","should be perpendicular to the plane normal and aligned with the z-axis. \"\"\"","= 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum =","Foundation; either version 3 of the License, or # (at your option) any","photon.id = self.throw self.throw = self.throw + 1 return photon class PlanarSource(object): \"\"\"A","r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center,","self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation !=","of the Laser is not set.\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id","self.wavelength = wavelength assert polarisation != None, \"Polarisation of the Laser is not","tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum","boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus #","0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active","= np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\" + str(id(self)) def photon(self): photon","class RadialSource(object): \"\"\" A point source that emits at discrete angles theta(i) and","= self.throw self.throw = self.throw + 1 # Create a point which is","= focussize self.throw = 0 self.source_id = \"LensSource_\" + str(id(self)) def photon(self): photon","True return photon class RadialSource(object): \"\"\" A point source that emits at discrete","photon class PlanarSource(object): \"\"\"A box that emits photons from the top surface (normal),","the License, or # (at your option) any later version. # # pvtrace","np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation is set generate","self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id","y = np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the direciton","angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id","of incidence in z-direction). \"\"\" def __init__(self, spectrum = None, wavelength = 555,","class PointSource(object): \"\"\" A point source that emits randomly in solid angle specified","thetamax \"\"\" def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.),","= 0 self.source_id = \"LaserSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source","with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations","self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin = phimin","self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin,","None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \"\"\"","to the plane normal and aligned with the z-axis. \"\"\" def __init__(self, spectrum","position inside a cylinder(radius, length) \"\"\" def __init__(self, spectrum = None, wavelength =","self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection","focused on a line with space tolerance given by variable \"focussize\". The focus","= np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation =","linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__()","photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:","True photon.wavelength = self.wavelength # If use_polarisation is set generate a random polarisation","of the finite plane in it's local frame x = np.random.uniform(0., self.length) y","np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction","= width # direction is the direction that photons are fired out of","position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction","+ np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position modulus","lense an additional z-boost is added (Angle of incidence in z-direction). \"\"\" def","= 0 self.source_id = \"PointSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source","a * y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that will generate","\"\"\"A light source that will generate photons of a single colour, direction and","from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon","self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength","= self.wavelength return photon class LensSource(object): \"\"\" A source where photons generated in","will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty","= (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin","cylinder(radius, length) \"\"\" def __init__(self, spectrum = None, wavelength = 555, radius =","= np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation is set","str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw +","= np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z =","class PlanarSource(object): \"\"\"A box that emits photons from the top surface (normal), sampled","- boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0]","transform) photon.direction = direction photon.position = point if self.spectrum != None: photon.wavelength =","= np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point =","your option) any later version. # # pvtrace is distributed in the hope","focussize self.angle = angle self.throw = 0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def","else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \"\"\" A source where photons","plane in the GLOBAL FRAME. # i.e. this is passed directly to the","str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self):","super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation","= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object):","normal and aligned with the z-axis. For this lense an additional z-boost is","wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent =","2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length)","photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw +","spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint)","__init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction)","is taken from GNU Scientific Library LOOP = True while LOOP: x =","np.random.uniform() y = -1. + 2. * np.random.uniform() s = x**2 + y**2","x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.)","on a line with space tolerance given by variable \"focussize\". The focus line","phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum","photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position","= spacing self.throw = 0 self.source_id = \"RadialSource_\" + str(id(self)) def photon(self): photon","photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus #","self.source_id = \"LensSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id","without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR","wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane","transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x","y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point","\"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis))","length self.throw = 0 self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation))","self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position x =","a cylinder(radius, length) \"\"\" def __init__(self, spectrum = None, wavelength = 555, radius","1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y","center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax","photon.id = self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta","self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw","= Cylinder(radius = radius, length = length) self.radius = radius self.length = length","photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength #","You should have received a copy of the GNU General Public License #","= norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation =","return photon class RadialSource(object): \"\"\" A point source that emits at discrete angles","self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length =","None photon.id = self.throw self.throw = self.throw + 1 return photon class Laser(object):","the terms of the GNU General Public License as published by # the","photon.active = True return photon class PointSource(object): \"\"\" A point source that emits","np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] =","None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent","= self.source_id photon.id = self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin,","use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self): photon =","wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin","= 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum","self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id = \"RadialSource_\" +","aligned with the z-axis. For this lense an additional z-boost is added (Angle","0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else:","= thetamax self.throw = 0 self.source_id = \"PointSource_\" + str(id(self)) def photon(self): photon","photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id","self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z)","rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This method of calculating","the surface of the finite plane in it's local frame x = np.random.uniform(0.,","LensSourceAngle(object): \"\"\" A source where photons generated in a plane are focused on","= np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction","photon class Laser(object): \"\"\"A light source that will generate photons of a single","self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source","= 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum","finite plane in it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0.,","the top surface (normal), sampled from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1),","self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw","np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace import","in solid angle specified by phimin, ..., thetamax \"\"\" def __init__(self, spectrum =","FinitePlane(length=length, width=width) self.length = length self.width = width # direction is the direction","np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform","set generate a random polarisation vector of the photon if self.use_random_polarisation: # Randomise","photon.direction = direction photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())","self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum != None: photon.wavelength =","with the z-axis. For this lense an additional z-boost is added (Angle of","inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta =","super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin =","self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1)","= Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1","along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from","it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point =","Photon() photon.id = self.throw self.throw = self.throw + 1 # Position x =","direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction","= np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1]","be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y =","= self.throw + 1 # Create a point which is on the surface","(no need to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta","self.shape.transform) # Direction of emission (no need to transform if meant to be","r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center","0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__()","focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position","planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin =","solid angle specified by phimin, ..., thetamax \"\"\" def __init__(self, spectrum = None,","General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. import","of the plane in the GLOBAL FRAME. # i.e. this is passed directly","np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that will generate photons of a single","(Angle of incidence in z-direction). \"\"\" def __init__(self, spectrum = None, wavelength =","self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize","super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent =","\"LensSourceAngle_\" + str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw =","# Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position =","vectors is taken from GNU Scientific Library LOOP = True while LOOP: x","photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from +z","boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction","the GNU General Public License as published by # the Free Software Foundation;","vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1])","in a plane are focused on a line with space tolerance given by","= np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id =","self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta","str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction","photons generated in a plane are focused on a line with space tolerance","= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \"\"\" A source","and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position","wavelength = 555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum =","self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self):","+ boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus","by phimin, ..., thetamax \"\"\" def __init__(self, spectrum = None, wavelength = 555,","= length) self.radius = radius self.length = length self.throw = 0 self.source_id =","not set.\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\" + str(id(self))","= 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength","= position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw =","self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width # direction is","of a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False):","the plane normal and aligned with the z-axis. For this lense an additional","= np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \"LensSource_\" + str(id(self))","generate photons of a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1],","phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource,","else: photon.wavelength = self.wavelength # Further initialisation photon.active = True return photon class","= self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength =","direction photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength","y = a * y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that","# Further initialisation photon.active = True return photon class PointSource(object): \"\"\" A point","direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\"","= (x, y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction","transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw = self.throw +","self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \"\"\" A source where","the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum =","it will be useful, # but WITHOUT ANY WARRANTY; without even the implied","\"\"\" A source for photons emitted in a random direction and position inside","photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 phi =","Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy","xy-plane, the transform from +z to the direction of the photon vec =","self.throw = 0 self.source_id = \"PointSource_\" + str(id(self)) def photon(self): photon = Photon()","a point which is on the surface of the finite plane in it's","return photon class Laser(object): \"\"\"A light source that will generate photons of a","y**2 if s <= 1.0: LOOP = False z = -1. + 2.","555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength","a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource,","= np.array(direction) self.wavelength = wavelength assert polarisation != None, \"Polarisation of the Laser","be perpendicular to the plane normal and aligned with the z-axis. For this","i.e. this is passed directly to the photon to set is's direction self.direction","= np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center =","if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from +z to","10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius =","the # GNU General Public License for more details. # # You should","..., thetamax \"\"\" def __init__(self, spectrum = None, wavelength = 555, center =","True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw","external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon from","transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This method of","def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength","= np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the direciton photon.position","= spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length = length)","super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent =","555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0,","else: photon.polarisation = None photon.id = self.throw self.throw = self.throw + 1 return","__init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction","generate a random polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation","# the Free Software Foundation; either version 3 of the License, or #","super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length","Free Software Foundation; either version 3 of the License, or # (at your","photons of a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555,","specified by phimin, ..., thetamax \"\"\" def __init__(self, spectrum = None, wavelength =","and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position)","self.throw = self.throw + 1 # Position of emission phi = np.random.uniform(0., 2*np.pi)","wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection)","plane are focused on a line with space tolerance given by variable \"focussize\".","norm from Materials import Spectrum def random_spherecial_vector(): # This method of calculating isotropic","PARTICULAR PURPOSE. See the # GNU General Public License for more details. #","a random polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation angle","2. * np.random.uniform() y = -1. + 2. * np.random.uniform() s = x**2","PlanarSource(object): \"\"\"A box that emits photons from the top surface (normal), sampled from","= np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of photon","width # direction is the direction that photons are fired out of the","free software; you can redistribute it and/or modify # it under the terms","focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum =","0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum","useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of #","axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =","x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position","on the surface of the finite plane in it's local frame x =","the GLOBAL FRAME. # i.e. this is passed directly to the photon to","even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.","= \"PointSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id","self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta)","= spectrum self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax =","photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi =","direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength","= phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id =","from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import","1 # Create a point which is on the surface of the finite","= False z = -1. + 2. * s a = 2 *","phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi)","None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active =","photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active","incidence in z-direction). \"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0),","__init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin = 0,","y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that will generate photons of","discrete angles theta(i) and phi(i) \"\"\" def __init__(self, spectrum = None, wavelength =","added (Angle of incidence in z-direction). \"\"\" def __init__(self, spectrum = None, wavelength","focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction =","colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position","vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec,","pvtrace is distributed in the hope that it will be useful, # but","= photon.position[2] + boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction","np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction","polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane,","local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of photon if self.spectrum","translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon()","photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 # Create","to the plane normal and aligned with the z-axis. For this lense an","photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active = True","= 0 self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source","= length self.throw = 0 self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self, translation):","= radius self.length = length self.throw = 0 self.source_id = \"CylindricalSource_\" + str(id(self))","radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength =","at discrete angles theta(i) and phi(i) \"\"\" def __init__(self, spectrum = None, wavelength","photon.active = True photon.wavelength = self.wavelength # If use_polarisation is set generate a","np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint","import external.transformations as tf from Trace import Photon from Geometry import Box, Cylinder,","r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction","is not set.\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\" +","planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength =","self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1)","= self.throw + 1 return photon class PlanarSource(object): \"\"\"A box that emits photons","Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): #","= wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\" + str(id(self))","= focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if","terms of the GNU General Public License as published by # the Free","Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm","self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax","emits randomly in solid angle specified by phimin, ..., thetamax \"\"\" def __init__(self,","Create a point which is on the surface of the finite plane in","aligned with the z-axis. \"\"\" def __init__(self, spectrum = None, wavelength = 555,","as tf from Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point,","source that emits at discrete angles theta(i) and phi(i) \"\"\" def __init__(self, spectrum","return photon class PointSource(object): \"\"\" A point source that emits randomly in solid","<http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as","thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center =","x = -1. + 2. * np.random.uniform() y = -1. + 2. *","with the z-axis. \"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0),","= True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength","= 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength","# Create a point which is on the surface of the finite plane","\"LensSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =","space tolerance given by variable \"focussize\". The focus line should be perpendicular to","= FinitePlane(length=length, width=width) self.length = length self.width = width # direction is the","= True while LOOP: x = -1. + 2. * np.random.uniform() y =","self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length =","self.angle = angle self.throw = 0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self):","photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw =","phimin, ..., thetamax \"\"\" def __init__(self, spectrum = None, wavelength = 555, center","True return photon class PointSource(object): \"\"\" A point source that emits randomly in","that emits at discrete angles theta(i) and phi(i) \"\"\" def __init__(self, spectrum =","self.source_id photon.id = self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax)","surface of the finite plane in it's local frame x = np.random.uniform(0., self.length)","x**2 + y**2 if s <= 1.0: LOOP = False z = -1.","np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z)","The focus line should be perpendicular to the plane normal and aligned with","= self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi = np.random.randint(1,","and aligned with the z-axis. \"\"\" def __init__(self, spectrum = None, wavelength =","wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =","= np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw =","= self.wavelength # If use_polarisation is set generate a random polarisation vector of","self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width","ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR","= self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost","the plane in the GLOBAL FRAME. # i.e. this is passed directly to","source where photons generated in a plane are focused on a line with","self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation","WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS","photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength #","# # You should have received a copy of the GNU General Public","source that will generate photons of a single colour, direction and position.\"\"\" def","= planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw =","2. * np.random.uniform() s = x**2 + y**2 if s <= 1.0: LOOP","and aligned with the z-axis. For this lense an additional z-boost is added","modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength","a random direction and position inside a cylinder(radius, length) \"\"\" def __init__(self, spectrum","else: photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object): \"\"\" A","Public License for more details. # # You should have received a copy","direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum","self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent","self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object): \"\"\"","photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \"\"\" A","= self.throw self.throw = self.throw + 1 return photon class PlanarSource(object): \"\"\"A box","self.direction photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength","set.\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\" + str(id(self)) def","line should be perpendicular to the plane normal and aligned with the z-axis.","self.length = length self.width = width # direction is the direction that photons","photon class RadialSource(object): \"\"\" A point source that emits at discrete angles theta(i)","for photons emitted in a random direction and position inside a cylinder(radius, length)","np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center,","+ np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction","self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source","= True return photon class RadialSource(object): \"\"\" A point source that emits at","out of the plane in the GLOBAL FRAME. # i.e. this is passed","return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that will generate photons of a","= 2 * np.sqrt(1 - s) x = a * x y =","rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw","that will generate photons of a single colour, direction and position.\"\"\" def __init__(self,","colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position","self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length","= \"SimpleSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position","rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id","= \"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle,","phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y =","1 return photon class PlanarSource(object): \"\"\"A box that emits photons from the top","np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z =","else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \"\"\" A source for photons","None, wavelength = 555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum","= self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x","self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None, \"Polarisation of the","focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum =","from the top surface (normal), sampled from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555,","else: photon.wavelength = self.wavelength return photon class LensSource(object): \"\"\" A source where photons","= 0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self): photon = Photon() photon.id","top surface (normal), sampled from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05,","np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \"LensSource_\" + str(id(self)) def","= rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id =","= (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need to","= x**2 + y**2 if s <= 1.0: LOOP = False z =","self.throw = 0 self.source_id = \"RadialSource_\" + str(id(self)) def photon(self): photon = Photon()","phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z","focussize self.throw = 0 self.source_id = \"LensSource_\" + str(id(self)) def photon(self): photon =","that emits photons from the top surface (normal), sampled from the spectrum.\"\"\" def","not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix import","\"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize =","length) \"\"\" def __init__(self, spectrum = None, wavelength = 555, radius = 1,","vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation","transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This method","None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \"\"\"","numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from","0 self.source_id = \"LaserSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source =","0 self.source_id = \"PointSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source =","!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return","photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object): \"\"\" A point","focus line should be perpendicular to the plane normal and aligned with the","photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength","is on the surface of the finite plane in it's local frame x","WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A","z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.))","that it will be useful, # but WITHOUT ANY WARRANTY; without even the","= np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center","the finite plane in it's local frame x = np.random.uniform(0., self.length) y =","be perpendicular to the plane normal and aligned with the z-axis. \"\"\" def","wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width # direction","photon.wavelength = self.wavelength # Further initialisation photon.active = True return photon class PointSource(object):","+ str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position)","implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the","\"RadialSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =","= np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta)","+ 1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius)","def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw =","radius, length = length) self.radius = radius self.length = length self.throw = 0","This method of calculating isotropic vectors is taken from GNU Scientific Library LOOP","the hope that it will be useful, # but WITHOUT ANY WARRANTY; without","np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of photon if","True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return","planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize","= self.throw + 1 return photon class Laser(object): \"\"\"A light source that will","source for photons emitted in a random direction and position inside a cylinder(radius,","\"\"\" A point source that emits randomly in solid angle specified by phimin,","+ 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta)","= np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0]","photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \"\"\" A","linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum","np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength","!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object):","a copy of the GNU General Public License # along with this program.","self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id","x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction","= a * x y = a * y return np.array([x,y,z]) class SimpleSource(object):","A PARTICULAR PURPOSE. See the # GNU General Public License for more details.","Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi)","0 self.source_id = \"LensSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source =","# This method of calculating isotropic vectors is taken from GNU Scientific Library","RadialSource(object): \"\"\" A point source that emits at discrete angles theta(i) and phi(i)","polarisation != None, \"Polarisation of the Laser is not set.\" self.polarisation = np.array(polarisation)","the Free Software Foundation; either version 3 of the License, or # (at","y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint =","return photon class LensSourceAngle(object): \"\"\" A source where photons generated in a plane","photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction)","= self.polarisation photon.id = self.throw self.throw = self.throw + 1 return photon class","frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y,","class LensSource(object): \"\"\" A source where photons generated in a plane are focused","(x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position =","point = transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum !=","published by # the Free Software Foundation; either version 3 of the License,","= -1. + 2. * np.random.uniform() y = -1. + 2. * np.random.uniform()","the Laser is not set.\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id =","self.wavelength # Further initialisation photon.active = True return photon class PointSource(object): \"\"\" A","False z = -1. + 2. * s a = 2 * np.sqrt(1","self.source_id = \"PointSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id","= planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle =","License # along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as","= r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position =","width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width)","= 555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin =","0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self): photon = Photon() photon.id =","+ 1 # Create a point which is on the surface of the","around xy-plane, the transform from +z to the direction of the photon vec","(x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform","np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None, \"Polarisation of","a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser,","in z-direction). \"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1),","self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None,","is passed directly to the photon to set is's direction self.direction = direction","self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self): photon = Photon() photon.id = self.throw","= length self.width = width # direction is the direction that photons are","= phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw =","photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation is","software; you can redistribute it and/or modify # it under the terms of","emits at discrete angles theta(i) and phi(i) \"\"\" def __init__(self, spectrum = None,","photon.polarisation = None photon.id = self.throw self.throw = self.throw + 1 return photon","np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position modulus =","wavelength self.shape = Cylinder(radius = radius, length = length) self.radius = radius self.length","1.0: LOOP = False z = -1. + 2. * s a =","\"Polarisation of the Laser is not set.\" self.polarisation = np.array(polarisation) self.throw = 0","plane normal and aligned with the z-axis. For this lense an additional z-boost","LOOP: x = -1. + 2. * np.random.uniform() y = -1. + 2.","self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class","np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint -","perpendicular to the plane normal and aligned with the z-axis. For this lense","self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x =","General Public License for more details. # # You should have received a","np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] =","self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta","external.transformations as tf from Trace import Photon from Geometry import Box, Cylinder, FinitePlane,","CylindricalSource(object): \"\"\" A source for photons emitted in a random direction and position","direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane =","LOOP = True while LOOP: x = -1. + 2. * np.random.uniform() y","the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See","angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id","# If use_polarisation is set generate a random polarisation vector of the photon","555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource,","light source that will generate photons of a single colour, direction and position.\"\"\"","passed directly to the photon to set is's direction self.direction = direction self.throw","R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id","line with space tolerance given by variable \"focussize\". The focus line should be","y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction","Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi","a plane are focused on a line with space tolerance given by variable","photon.direction = self.direction photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())","= None, wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax =","!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object):","position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction","= direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength","(at your option) any later version. # # pvtrace is distributed in the","= thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \"PointSource_\" + str(id(self))","self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax)","more details. # # You should have received a copy of the GNU","z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform)","GNU General Public License for more details. # # You should have received","1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if","under the terms of the GNU General Public License as published by #","= self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] +","= \"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle,","= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \"\"\" A source","transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum != None: photon.wavelength","def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon","np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] +","self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \"\"\" A source for","it under the terms of the GNU General Public License as published by","Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] +","you can redistribute it and/or modify # it under the terms of the","transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum != None: photon.wavelength","np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center","of the License, or # (at your option) any later version. # #","position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength","hope that it will be useful, # but WITHOUT ANY WARRANTY; without even","perpendicular to the plane normal and aligned with the z-axis. \"\"\" def __init__(self,","x = a * x y = a * y return np.array([x,y,z]) class","is set generate a random polarisation vector of the photon if self.use_random_polarisation: #","+ 2. * s a = 2 * np.sqrt(1 - s) x =","# Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength","y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position =","photon class LensSourceAngle(object): \"\"\" A source where photons generated in a plane are","photon class CylindricalSource(object): \"\"\" A source for photons emitted in a random direction","[0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw","see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations","self.polarisation photon.id = self.throw self.throw = self.throw + 1 return photon class PlanarSource(object):","= wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection =","np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation","focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum","of emission (no need to transform if meant to be isotropic) phi =","(x, y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction =","= Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active =","= wavelength assert polarisation != None, \"Polarisation of the Laser is not set.\"","0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center","self.throw self.throw = self.throw + 1 return photon class PlanarSource(object): \"\"\"A box that","self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length","1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z","# direction is the direction that photons are fired out of the plane","direction of the photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec)","self.throw self.throw = self.throw + 1 # Create a point which is on","= transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum != None:","1 return photon class Laser(object): \"\"\"A light source that will generate photons of","spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize =","photon.wavelength = self.wavelength # If use_polarisation is set generate a random polarisation vector","vector of the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the","self.thetamax = thetamax self.throw = 0 self.source_id = \"PointSource_\" + str(id(self)) def photon(self):","License as published by # the Free Software Foundation; either version 3 of","* s a = 2 * np.sqrt(1 - s) x = a *","be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of","np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position","planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength =","self.wavelength return photon class CylindricalSource(object): \"\"\" A source for photons emitted in a","y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform)","plane normal and aligned with the z-axis. \"\"\" def __init__(self, spectrum = None,","import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def","spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length = length) self.radius","self.width = width # direction is the direction that photons are fired out","normal and aligned with the z-axis. \"\"\" def __init__(self, spectrum = None, wavelength","to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi)","GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>.","np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0]","boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] +","directly to the photon to set is's direction self.direction = direction self.throw =","focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint","self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi =","thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id = \"RadialSource_\"","= np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center =","thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength =","= -1. + 2. * s a = 2 * np.sqrt(1 - s)","are focused on a line with space tolerance given by variable \"focussize\". The","that photons are fired out of the plane in the GLOBAL FRAME. #","= self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position x","Laser(object): \"\"\"A light source that will generate photons of a single colour, direction","+ str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw","but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or","and position inside a cylinder(radius, length) \"\"\" def __init__(self, spectrum = None, wavelength","np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0))","= 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum","self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z =","np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z)","= np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0 self.source_id =","0 self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source =","np.sqrt(1 - s) x = a * x y = a * y","np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin","emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y =","plane in it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width)","direction and position inside a cylinder(radius, length) \"\"\" def __init__(self, spectrum = None,","np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw","= self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta =","is free software; you can redistribute it and/or modify # it under the","= planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize =","+ 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle)","by variable \"focussize\". The focus line should be perpendicular to the plane normal","self.throw = self.throw + 1 return photon class PlanarSource(object): \"\"\"A box that emits","+ 2. * np.random.uniform() s = x**2 + y**2 if s <= 1.0:","photon.id = self.throw self.throw = self.throw + 1 # Create a point which","spectrum self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax = phimax","else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta)","Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 phi","GNU Scientific Library LOOP = True while LOOP: x = -1. + 2.","= np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction =","\"PointSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =","variable \"focussize\". The focus line should be perpendicular to the plane normal and","self.throw self.throw = self.throw + 1 return photon class Laser(object): \"\"\"A light source","= random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation","= self.throw self.throw = self.throw + 1 # Position of emission phi =","s <= 1.0: LOOP = False z = -1. + 2. * s","this is passed directly to the photon to set is's direction self.direction =","direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =","None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon","direction self.throw = 0 self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation))","the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if","theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction","self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \"LensSource_\" +","planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle","theta(i) and phi(i) \"\"\" def __init__(self, spectrum = None, wavelength = 555, center","If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix","self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z =","= spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width","= \"LensSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id","self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw","self.throw = 0 self.source_id = \"LensSourceAngle_\" + str(id(self)) def photon(self): photon = Photon()","photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw + 1 #","have received a copy of the GNU General Public License # along with","angles theta(i) and phi(i) \"\"\" def __init__(self, spectrum = None, wavelength = 555,","= direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id =","self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis):","theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta)","y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint =","self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost","0 self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle,","photons are fired out of the plane in the GLOBAL FRAME. # i.e.","set is's direction self.direction = direction self.throw = 0 self.source_id = \"PlanarSource_\" +","in the GLOBAL FRAME. # i.e. this is passed directly to the photon","spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax","wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \"SimpleSource_\" + str(id(self)) def","option) any later version. # # pvtrace is distributed in the hope that","pvtrace is free software; you can redistribute it and/or modify # it under","# Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1]","= Photon() photon.id = self.throw self.throw = self.throw + 1 # Position x","self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the","A source where photons generated in a plane are focused on a line","= 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__()","phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20):","is the direction that photons are fired out of the plane in the","the z-axis. For this lense an additional z-boost is added (Angle of incidence","focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5","Software Foundation; either version 3 of the License, or # (at your option)","photon.id = self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta","sampled from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__()","s) x = a * x y = a * y return np.array([x,y,z])","PURPOSE. See the # GNU General Public License for more details. # #","= 555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum","= self.wavelength photon.active = True return photon class RadialSource(object): \"\"\" A point source","self.throw = 0 self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self): photon = Photon()","np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no","# pvtrace is free software; you can redistribute it and/or modify # it","self.throw = self.throw + 1 return photon class Laser(object): \"\"\"A light source that","self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\" + str(id(self)) def photon(self):","self.direction = direction self.throw = 0 self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self,","self.center = center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax","= \"LaserSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position","random direction and position inside a cylinder(radius, length) \"\"\" def __init__(self, spectrum =","= a * y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source that will","= self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta =","= \"LensSourceAngle_\" + str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw","import Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors is taken","photon to set is's direction self.direction = direction self.throw = 0 self.source_id =","= None, wavelength = 555, radius = 1, length = 10): super(CylindricalSource, self).__init__()","z = -1. + 2. * s a = 2 * np.sqrt(1 -","any later version. # # pvtrace is distributed in the hope that it","x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) -","self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \"PointSource_\" +","photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw","the GNU General Public License # along with this program. If not, see","photons from the top surface (normal), sampled from the spectrum.\"\"\" def __init__(self, spectrum=None,","np.array(direction) self.wavelength = wavelength assert polarisation != None, \"Polarisation of the Laser is","Library LOOP = True while LOOP: x = -1. + 2. * np.random.uniform()","a line with space tolerance given by variable \"focussize\". The focus line should","photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw + 1 return photon","of the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform","= self.wavelength return photon class CylindricalSource(object): \"\"\" A source for photons emitted in","details. # # You should have received a copy of the GNU General","single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__()","box that emits photons from the top surface (normal), sampled from the spectrum.\"\"\"","import numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf","= np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set","self.wavelength return photon class LensSourceAngle(object): \"\"\" A source where photons generated in a","= np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin","class Laser(object): \"\"\"A light source that will generate photons of a single colour,","random polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation angle around","is added (Angle of incidence in z-direction). \"\"\" def __init__(self, spectrum = None,","= True photon.wavelength = self.wavelength # If use_polarisation is set generate a random","length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape =","(x,y,z) photon.direction = local_direction # Set wavelength of photon if self.spectrum != None:","self.spacing = spacing self.throw = 0 self.source_id = \"RadialSource_\" + str(id(self)) def photon(self):","= np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction =","np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax:","if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x =","point source that emits randomly in solid angle specified by phimin, ..., thetamax","self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1])","photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize)","= np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.))","spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength","use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation","and phi(i) \"\"\" def __init__(self, spectrum = None, wavelength = 555, center =","= tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position = point if","= self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint -","self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw","of a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None):","position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength","__init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize","polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert","= np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2]","# GNU General Public License for more details. # # You should have","taken from GNU Scientific Library LOOP = True while LOOP: x = -1.","- photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum !=","direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength =","self.throw = 0 self.source_id = \"LensSource_\" + str(id(self)) def photon(self): photon = Photon()","= self.wavelength # Further initialisation photon.active = True return photon class PointSource(object): \"\"\"","str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw","it and/or modify # it under the terms of the GNU General Public","assert polarisation != None, \"Polarisation of the Laser is not set.\" self.polarisation =","np.random.uniform() s = x**2 + y**2 if s <= 1.0: LOOP = False","= np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z","* x y = a * y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light","def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction =","self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw","= -1. + 2. * np.random.uniform() s = x**2 + y**2 if s","as published by # the Free Software Foundation; either version 3 of the","= np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0]","phi(i) \"\"\" def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.),","isotropic vectors is taken from GNU Scientific Library LOOP = True while LOOP:","the transform from +z to the direction of the photon vec = random_spherecial_vector()","A source for photons emitted in a random direction and position inside a","# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General","0 self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle,","photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =","self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint","self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id","direction self.direction = direction self.throw = 0 self.source_id = \"PlanarSource_\" + str(id(self)) def","norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None","If use_polarisation is set generate a random polarisation vector of the photon if","local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need","intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x","= center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax =","self).__init__() self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation","are fired out of the plane in the GLOBAL FRAME. # i.e. this","the photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R =","thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength","Direction of emission (no need to transform if meant to be isotropic) phi","np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation","= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active = True return","= (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin","= 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R)","self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction =","x y = a * y return np.array([x,y,z]) class SimpleSource(object): \"\"\"A light source","# Set wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:","= (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength =","np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction =","= 0 self.source_id = \"LensSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source","Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return","z-boost is added (Angle of incidence in z-direction). \"\"\" def __init__(self, spectrum =","np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) #","= self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position of","focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2]","np.array(polarisation) self.throw = 0 self.source_id = \"LaserSource_\" + str(id(self)) def photon(self): photon =","__init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength =","* np.random.uniform() y = -1. + 2. * np.random.uniform() s = x**2 +","def __init__(self, spectrum = None, wavelength = 555, radius = 1, length =","will generate photons of a single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0],","s = x**2 + y**2 if s <= 1.0: LOOP = False z","the plane normal and aligned with the z-axis. \"\"\" def __init__(self, spectrum =","translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon =","length) self.radius = radius self.length = length self.throw = 0 self.source_id = \"CylindricalSource_\"","surface (normal), sampled from the spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05):","spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin =","0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength","emission (no need to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi)","self.throw = 0 self.source_id = \"LaserSource_\" + str(id(self)) def photon(self): photon = Photon()","wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin =","spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width =","= np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction","np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \"LensSource_\"","spectrum.\"\"\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum","or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License","self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z =","photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None:","np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z","\"CylindricalSource_\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis))","linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent =","photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum !=","if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further","def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin =","distributed in the hope that it will be useful, # but WITHOUT ANY","either version 3 of the License, or # (at your option) any later","self.focussize = focussize self.angle = angle self.throw = 0 self.source_id = \"LensSourceAngle_\" +","from Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment,","use_polarisation is set generate a random polarisation vector of the photon if self.use_random_polarisation:","def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source =","of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y","photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw +","of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength","# Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active =","Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 #","if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active =","need to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta =","np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] =","calculating isotropic vectors is taken from GNU Scientific Library LOOP = True while","while LOOP: x = -1. + 2. * np.random.uniform() y = -1. +","= 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)):","thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center","\"LaserSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position =","= (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength","== self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y","emits photons from the top surface (normal), sampled from the spectrum.\"\"\" def __init__(self,","0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum","self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw","= self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z","* np.sqrt(1 - s) x = a * x y = a *","= self.source_id photon.id = self.throw self.throw = self.throw + 1 # Create a","= np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z))","is's direction self.direction = direction self.throw = 0 self.source_id = \"PlanarSource_\" + str(id(self))","Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z))","self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id","the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from","= None photon.id = self.throw self.throw = self.throw + 1 return photon class","photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =","2 * np.sqrt(1 - s) x = a * x y = a","width=width) self.length = length self.width = width # direction is the direction that","self.source_id photon.id = self.throw self.throw = self.throw + 1 # Create a point","self.throw = 0 self.source_id = \"PlanarSource_\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def","General Public License as published by # the Free Software Foundation; either version","self.source_id = \"SimpleSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id","self.focussize = focussize self.throw = 0 self.source_id = \"LensSource_\" + str(id(self)) def photon(self):","return photon class LensSource(object): \"\"\" A source where photons generated in a plane","def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0,","np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0 self.source_id = \"LensSourceAngle_\"","as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace","= self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus","class LensSourceAngle(object): \"\"\" A source where photons generated in a plane are focused","rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id","(0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi,","= point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength","photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon class","\"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle =","planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0","self.wavelength return photon class LensSource(object): \"\"\" A source where photons generated in a","axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =","from GNU Scientific Library LOOP = True while LOOP: x = -1. +","a = 2 * np.sqrt(1 - s) x = a * x y","A point source that emits randomly in solid angle specified by phimin, ...,","\"\"\" def __init__(self, spectrum = None, wavelength = 555, radius = 1, length","self.width) local_point = (x, y, 0.) # Transform the direciton photon.position = transform_point(local_point,","from +z to the direction of the photon vec = random_spherecial_vector() vec[2] =","def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source =","wavelength self.center = center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin","1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x","= np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None, \"Polarisation","phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \"PointSource_\"","and/or modify # it under the terms of the GNU General Public License","Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors is taken from","z-axis. \"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize","= focussize self.angle = angle self.throw = 0 self.source_id = \"LensSourceAngle_\" + str(id(self))","z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of","super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius,","single colour, direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__()","= photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus","spectrum = None, wavelength = 555, radius = 1, length = 10): super(CylindricalSource,","1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position","local_direction # Set wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())","point source that emits at discrete angles theta(i) and phi(i) \"\"\" def __init__(self,","where photons generated in a plane are focused on a line with space","phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0","(-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin","# pvtrace is distributed in the hope that it will be useful, #","self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active = True return photon","self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y =","np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0","-1. + 2. * s a = 2 * np.sqrt(1 - s) x","planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin =","z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] =","direction and position.\"\"\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position =","= wavelength self.shape = Cylinder(radius = radius, length = length) self.radius = radius","focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize)","method of calculating isotropic vectors is taken from GNU Scientific Library LOOP =","modify # it under the terms of the GNU General Public License as","Further initialisation photon.active = True return photon class PointSource(object): \"\"\" A point source","= inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction =","!= None, \"Polarisation of the Laser is not set.\" self.polarisation = np.array(polarisation) self.throw","= transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum != None:","the direction that photons are fired out of the plane in the GLOBAL","given by variable \"focussize\". The focus line should be perpendicular to the plane","linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)):","0 self.source_id = \"RadialSource_\" + str(id(self)) def photon(self): photon = Photon() photon.source =","phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0","generated in a plane are focused on a line with space tolerance given","= 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource,","z-direction). \"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle","return photon class PlanarSource(object): \"\"\"A box that emits photons from the top surface","the z-axis. \"\"\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1),","phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing","See the # GNU General Public License for more details. # # You","- s) x = a * x y = a * y return","isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta)","to set is's direction self.direction = direction self.throw = 0 self.source_id = \"PlanarSource_\"","photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation","__init__(self, spectrum = None, wavelength = 555, radius = 1, length = 10):","self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle","None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin","super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation =","(-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent","__init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin","photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction,","self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position","Public License as published by # the Free Software Foundation; either version 3","<= 1.0: LOOP = False z = -1. + 2. * s a","to the direction of the photon vec = random_spherecial_vector() vec[2] = 0. vec","= True return photon class PointSource(object): \"\"\" A point source that emits randomly","transform from +z to the direction of the photon vec = random_spherecial_vector() vec[2]","R) else: photon.polarisation = None photon.id = self.throw self.throw = self.throw + 1","center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax","= y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint","Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2])","thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \"PointSource_\" + str(id(self)) def","FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more","(-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin","inside a cylinder(radius, length) \"\"\" def __init__(self, spectrum = None, wavelength = 555,","self.throw self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y =","= self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z","to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y","= r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) #","def random_spherecial_vector(): # This method of calculating isotropic vectors is taken from GNU","Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials","photons emitted in a random direction and position inside a cylinder(radius, length) \"\"\"","photon.id = self.throw self.throw = self.throw + 1 # Position of emission phi","self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax = phimax self.thetamin","y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction #","= self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction","(direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())","# along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np","= radius, length = length) self.radius = radius self.length = length self.throw =","from Materials import Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors","# Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z =","# (at your option) any later version. # # pvtrace is distributed in","None, wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi,","= np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.) #","SimpleSource(object): \"\"\"A light source that will generate photons of a single colour, direction","1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape","def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0,","# but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY","this lense an additional z-boost is added (Angle of incidence in z-direction). \"\"\"","which is on the surface of the finite plane in it's local frame","self.length = length self.throw = 0 self.source_id = \"CylindricalSource_\" + str(id(self)) def translate(self,","self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw","# Randomise rotation angle around xy-plane, the transform from +z to the direction","+z to the direction of the photon vec = random_spherecial_vector() vec[2] = 0."],"string":"[\n \"wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength\",\n \"photon.active = True return photon class RadialSource(object): \\\"\\\"\\\" A point source that emits\",\n \"Laser is not set.\\\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\"\",\n \"= True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw =\",\n \"= self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw + 1\",\n \"self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def\",\n \"+ y**2 if s <= 1.0: LOOP = False z = -1. +\",\n \"should be perpendicular to the plane normal and aligned with the z-axis. For\",\n \"self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1,\",\n \"self.throw self.throw = self.throw + 1 # Position of emission phi = np.random.uniform(0.,\",\n \"self.wavelength photon.active = True return photon class RadialSource(object): \\\"\\\"\\\" A point source that\",\n \"= np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform =\",\n \"GLOBAL FRAME. # i.e. this is passed directly to the photon to set\",\n \"FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This\",\n \"\\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin\",\n \"point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active\",\n \"wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength = wavelength\",\n \"photon.position[2] + boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction =\",\n \"should have received a copy of the GNU General Public License # along\",\n \"if s <= 1.0: LOOP = False z = -1. + 2. *\",\n \"+ 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing\",\n \"x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform\",\n \"this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import\",\n \"(-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent\",\n \"= spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint =\",\n \"PointSource(object): \\\"\\\"\\\" A point source that emits randomly in solid angle specified by\",\n \"thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self): photon =\",\n \"length self.width = width # direction is the direction that photons are fired\",\n \"Set wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength\",\n \"= (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position\",\n \"+ np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5\",\n \"x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) #\",\n \"= 0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source\",\n \"return photon class CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted in a random\",\n \"FRAME. # i.e. this is passed directly to the photon to set is's\",\n \"= None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1),\",\n \"version. # # pvtrace is distributed in the hope that it will be\",\n \"For this lense an additional z-boost is added (Angle of incidence in z-direction).\",\n \"angle specified by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength\",\n \"z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of\",\n \"= np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission\",\n \"Cylinder(radius = radius, length = length) self.radius = radius self.length = length self.throw\",\n \"photon.id = self.throw self.throw = self.throw + 1 return photon class Laser(object): \\\"\\\"\\\"A\",\n \"self.throw + 1 return photon class Laser(object): \\\"\\\"\\\"A light source that will generate\",\n \"thetamax self.spacing = spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def\",\n \"point which is on the surface of the finite plane in it's local\",\n \"# You should have received a copy of the GNU General Public License\",\n \"angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon =\",\n \"= angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon\",\n \"\\\"focussize\\\". The focus line should be perpendicular to the plane normal and aligned\",\n \"# Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x =\",\n \"= np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin ==\",\n \"with space tolerance given by variable \\\"focussize\\\". The focus line should be perpendicular\",\n \"0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength\",\n \"3 of the License, or # (at your option) any later version. #\",\n \"self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon =\",\n \"= self.throw self.throw = self.throw + 1 return photon class Laser(object): \\\"\\\"\\\"A light\",\n \"= thetamax self.spacing = spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\" + str(id(self))\",\n \"# i.e. this is passed directly to the photon to set is's direction\",\n \"self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost =\",\n \"GNU General Public License as published by # the Free Software Foundation; either\",\n \"self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A source\",\n \"local_point = (x, y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform)\",\n \"\\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position =\",\n \"rotation angle around xy-plane, the transform from +z to the direction of the\",\n \"None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \\\"\\\"\\\"\",\n \"random_spherecial_vector(): # This method of calculating isotropic vectors is taken from GNU Scientific\",\n \"randomly in solid angle specified by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum\",\n \"of calculating isotropic vectors is taken from GNU Scientific Library LOOP = True\",\n \"length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length,\",\n \"super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin =\",\n \"= wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width #\",\n \"= 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength =\",\n \"= self.throw + 1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r\",\n \"+ str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def\",\n \"self.throw + 1 return photon class PlanarSource(object): \\\"\\\"\\\"A box that emits photons from\",\n \"self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True\",\n \"fired out of the plane in the GLOBAL FRAME. # i.e. this is\",\n \"wavelength assert polarisation != None, \\\"Polarisation of the Laser is not set.\\\" self.polarisation\",\n \"# it under the terms of the GNU General Public License as published\",\n \"direction that photons are fired out of the plane in the GLOBAL FRAME.\",\n \"photon.wavelength = self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted\",\n \"tf from Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction,\",\n \"Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum\",\n \"= (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax =\",\n \"direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position =\",\n \"# # pvtrace is distributed in the hope that it will be useful,\",\n \"= use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon\",\n \"direction is the direction that photons are fired out of the plane in\",\n \"spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon =\",\n \"+ np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint\",\n \"np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction =\",\n \"def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction =\",\n \"photon class LensSource(object): \\\"\\\"\\\" A source where photons generated in a plane are\",\n \"additional z-boost is added (Angle of incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum\",\n \"= phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing =\",\n \"= self.throw self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y\",\n \"to the photon to set is's direction self.direction = direction self.throw = 0\",\n \"that emits randomly in solid angle specified by phimin, ..., thetamax \\\"\\\"\\\" def\",\n \"transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform if meant to\",\n \"= 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1),\",\n \"spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin\",\n \"in a random direction and position inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self,\",\n \"direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength =\",\n \"+ str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw\",\n \"self.wavelength = wavelength self.shape = Cylinder(radius = radius, length = length) self.radius =\",\n \"warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #\",\n \"A point source that emits at discrete angles theta(i) and phi(i) \\\"\\\"\\\" def\",\n \"self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing\",\n \"angle around xy-plane, the transform from +z to the direction of the photon\",\n \"self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\" +\",\n \"np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction =\",\n \"local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x,\",\n \"if self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x =\",\n \"photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform if\",\n \"= direction photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:\",\n \"= 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self,\",\n \"emitted in a random direction and position inside a cylinder(radius, length) \\\"\\\"\\\" def\",\n \"self.radius = radius self.length = length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" +\",\n \"import translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon from Geometry\",\n \"= self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated in\",\n \"np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta)\",\n \"photon class PointSource(object): \\\"\\\"\\\" A point source that emits randomly in solid angle\",\n \"def photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction =\",\n \"True while LOOP: x = -1. + 2. * np.random.uniform() y = -1.\",\n \"= \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id\",\n \"+ 2. * np.random.uniform() y = -1. + 2. * np.random.uniform() s =\",\n \"* np.random.uniform() s = x**2 + y**2 if s <= 1.0: LOOP =\",\n \"-1. + 2. * np.random.uniform() y = -1. + 2. * np.random.uniform() s\",\n \"+ 1 return photon class PlanarSource(object): \\\"\\\"\\\"A box that emits photons from the\",\n \"an additional z-boost is added (Angle of incidence in z-direction). \\\"\\\"\\\" def __init__(self,\",\n \"theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta)\",\n \"= transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw = self.throw\",\n \"z-axis. For this lense an additional z-boost is added (Angle of incidence in\",\n \"= 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self,\",\n \"program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix,\",\n \"LensSource(object): \\\"\\\"\\\" A source where photons generated in a plane are focused on\",\n \"for more details. # # You should have received a copy of the\",\n \"translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon from Geometry import\",\n \"= transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform if meant\",\n \"self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A source where\",\n \"position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0\",\n \"2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength\",\n \"of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU\",\n \"photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated\",\n \"= 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius\",\n \"def photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw + 1\",\n \"= intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing\",\n \"(normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource,\",\n \"self.throw = self.throw + 1 # Create a point which is on the\",\n \"source that emits randomly in solid angle specified by phimin, ..., thetamax \\\"\\\"\\\"\",\n \"s a = 2 * np.sqrt(1 - s) x = a * x\",\n \"or # (at your option) any later version. # # pvtrace is distributed\",\n \"!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object):\",\n \"photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A\",\n \"self.throw + 1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r =\",\n \"of the photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R\",\n \"(0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi):\",\n \"Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True\",\n \"y = -1. + 2. * np.random.uniform() s = x**2 + y**2 if\",\n \"Scientific Library LOOP = True while LOOP: x = -1. + 2. *\",\n \"photon.id = self.throw self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0])\",\n \"tolerance given by variable \\\"focussize\\\". The focus line should be perpendicular to the\",\n \"np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else:\",\n \"Randomise rotation angle around xy-plane, the transform from +z to the direction of\",\n \"0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength\",\n \"= self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi\",\n \"self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from +z to the\",\n \"of the GNU General Public License as published by # the Free Software\",\n \"np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the direciton photon.position =\",\n \"\\\"\\\"\\\" A point source that emits at discrete angles theta(i) and phi(i) \\\"\\\"\\\"\",\n \"!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active\",\n \"Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True\",\n \"translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon()\",\n \"self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus =\",\n \"= (x,y,z) photon.direction = local_direction # Set wavelength of photon if self.spectrum !=\",\n \"inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z)\",\n \"the direction of the photon vec = random_spherecial_vector() vec[2] = 0. vec =\",\n \"photon = Photon() photon.id = self.throw self.throw = self.throw + 1 # Position\",\n \"= 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__()\",\n \"self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position of emission\",\n \"a * x y = a * y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A\",\n \"= phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw =\",\n \"self.shape = Cylinder(radius = radius, length = length) self.radius = radius self.length =\",\n \"+ 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2])\",\n \"later version. # # pvtrace is distributed in the hope that it will\",\n \"= direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation):\",\n \"phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta =\",\n \"theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction\",\n \"meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta)\",\n \"photon.direction = local_direction # Set wavelength of photon if self.spectrum != None: photon.wavelength\",\n \"transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position = point\",\n \"received a copy of the GNU General Public License # along with this\",\n \"Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector():\",\n \"\\\"\\\"\\\"A box that emits photons from the top surface (normal), sampled from the\",\n \"by # the Free Software Foundation; either version 3 of the License, or\",\n \"2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum\",\n \"= wavelength self.center = center self.phimin = phimin self.phimax = phimax self.thetamin =\",\n \"copy of the GNU General Public License # along with this program. If\",\n \"the photon to set is's direction self.direction = direction self.throw = 0 self.source_id\",\n \"\\\"\\\"\\\" A source where photons generated in a plane are focused on a\",\n \"import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from\",\n \"LOOP = False z = -1. + 2. * s a = 2\",\n \"= self.direction photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:\",\n \"class CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted in a random direction and\",\n \"axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw\",\n \"str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self):\",\n \"self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0 self.source_id\",\n \"photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw\",\n \"= None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0,\",\n \"self.throw + 1 # Create a point which is on the surface of\",\n \"self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw + 1 return\",\n \"self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis):\",\n \"photon.wavelength = self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A source where photons generated\",\n \"is distributed in the hope that it will be useful, # but WITHOUT\",\n \"in it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point\",\n \"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public\",\n \"random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation =\",\n \"in the hope that it will be useful, # but WITHOUT ANY WARRANTY;\",\n \"= (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength\",\n \"class SimpleSource(object): \\\"\\\"\\\"A light source that will generate photons of a single colour,\",\n \"from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum\",\n \"FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for\",\n \"License, or # (at your option) any later version. # # pvtrace is\",\n \"= thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id =\",\n \"555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent\",\n \"= np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id =\",\n \"+ str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def\",\n \"# Direction of emission (no need to transform if meant to be isotropic)\",\n \"if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon\",\n \"Materials import Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors is\",\n \"= local_direction # Set wavelength of photon if self.spectrum != None: photon.wavelength =\",\n \"angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle,\",\n \"initialisation photon.active = True return photon class PointSource(object): \\\"\\\"\\\" A point source that\",\n \"intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin\",\n \"can redistribute it and/or modify # it under the terms of the GNU\",\n \"+ 1 return photon class Laser(object): \\\"\\\"\\\"A light source that will generate photons\",\n \"version 3 of the License, or # (at your option) any later version.\",\n \"None, \\\"Polarisation of the Laser is not set.\\\" self.polarisation = np.array(polarisation) self.throw =\",\n \"-1. + 2. * np.random.uniform() s = x**2 + y**2 if s <=\",\n \"def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon\",\n \"= np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If\",\n \"self.wavelength # If use_polarisation is set generate a random polarisation vector of the\",\n \"= np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost\",\n \"radius self.length = length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def\",\n \"phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum =\",\n \"of the GNU General Public License # along with this program. If not,\",\n \"2. * s a = 2 * np.sqrt(1 - s) x = a\",\n \"License for more details. # # You should have received a copy of\",\n \"length = length) self.radius = radius self.length = length self.throw = 0 self.source_id\",\n \"rotation_matrix import external.transformations as tf from Trace import Photon from Geometry import Box,\",\n \"* y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that will generate photons\",\n \"= np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction\",\n \"redistribute it and/or modify # it under the terms of the GNU General\",\n \"should be perpendicular to the plane normal and aligned with the z-axis. \\\"\\\"\\\"\",\n \"= 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum =\",\n \"Foundation; either version 3 of the License, or # (at your option) any\",\n \"photon.id = self.throw self.throw = self.throw + 1 return photon class PlanarSource(object): \\\"\\\"\\\"A\",\n \"r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center,\",\n \"self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation !=\",\n \"of the Laser is not set.\\\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id\",\n \"self.wavelength = wavelength assert polarisation != None, \\\"Polarisation of the Laser is not\",\n \"tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum\",\n \"boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus #\",\n \"0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active\",\n \"= np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon\",\n \"class RadialSource(object): \\\"\\\"\\\" A point source that emits at discrete angles theta(i) and\",\n \"= self.throw self.throw = self.throw + 1 # Create a point which is\",\n \"= focussize self.throw = 0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self): photon\",\n \"True return photon class RadialSource(object): \\\"\\\"\\\" A point source that emits at discrete\",\n \"photon class PlanarSource(object): \\\"\\\"\\\"A box that emits photons from the top surface (normal),\",\n \"the License, or # (at your option) any later version. # # pvtrace\",\n \"np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation is set generate\",\n \"self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id\",\n \"y = np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the direciton\",\n \"angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id\",\n \"of incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555,\",\n \"class PointSource(object): \\\"\\\"\\\" A point source that emits randomly in solid angle specified\",\n \"thetamax \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.),\",\n \"= 0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source\",\n \"with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations\",\n \"self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin = phimin\",\n \"self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin,\",\n \"None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\"\",\n \"to the plane normal and aligned with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum\",\n \"position inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength =\",\n \"self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection\",\n \"focused on a line with space tolerance given by variable \\\"focussize\\\". The focus\",\n \"= np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation =\",\n \"linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__()\",\n \"photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:\",\n \"True photon.wavelength = self.wavelength # If use_polarisation is set generate a random polarisation\",\n \"of the finite plane in it's local frame x = np.random.uniform(0., self.length) y\",\n \"np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction\",\n \"= width # direction is the direction that photons are fired out of\",\n \"position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction\",\n \"+ np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position modulus\",\n \"lense an additional z-boost is added (Angle of incidence in z-direction). \\\"\\\"\\\" def\",\n \"= 0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source\",\n \"a * y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that will generate\",\n \"\\\"\\\"\\\"A light source that will generate photons of a single colour, direction and\",\n \"from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon\",\n \"self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength\",\n \"= self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A source where photons generated in\",\n \"will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty\",\n \"= (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin\",\n \"cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, radius =\",\n \"= np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation is set\",\n \"str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw +\",\n \"= np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z =\",\n \"class PlanarSource(object): \\\"\\\"\\\"A box that emits photons from the top surface (normal), sampled\",\n \"- boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0]\",\n \"transform) photon.direction = direction photon.position = point if self.spectrum != None: photon.wavelength =\",\n \"= np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point =\",\n \"your option) any later version. # # pvtrace is distributed in the hope\",\n \"focussize self.angle = angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def\",\n \"else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A source where photons\",\n \"plane in the GLOBAL FRAME. # i.e. this is passed directly to the\",\n \"str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self):\",\n \"super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation\",\n \"= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object):\",\n \"normal and aligned with the z-axis. For this lense an additional z-boost is\",\n \"wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent =\",\n \"2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length)\",\n \"photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw +\",\n \"spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint)\",\n \"__init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction)\",\n \"is taken from GNU Scientific Library LOOP = True while LOOP: x =\",\n \"np.random.uniform() y = -1. + 2. * np.random.uniform() s = x**2 + y**2\",\n \"x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.)\",\n \"on a line with space tolerance given by variable \\\"focussize\\\". The focus line\",\n \"phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum\",\n \"photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position\",\n \"= spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon\",\n \"photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus #\",\n \"self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR\",\n \"wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane\",\n \"transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x\",\n \"y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point\",\n \"\\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis))\",\n \"length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation))\",\n \"self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position x =\",\n \"a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, radius\",\n \"1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y\",\n \"center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax\",\n \"photon.id = self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta\",\n \"self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw\",\n \"= Cylinder(radius = radius, length = length) self.radius = radius self.length = length\",\n \"photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength #\",\n \"You should have received a copy of the GNU General Public License #\",\n \"= norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation =\",\n \"return photon class RadialSource(object): \\\"\\\"\\\" A point source that emits at discrete angles\",\n \"self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length =\",\n \"None photon.id = self.throw self.throw = self.throw + 1 return photon class Laser(object):\",\n \"the terms of the GNU General Public License as published by # the\",\n \"photon.active = True return photon class PointSource(object): \\\"\\\"\\\" A point source that emits\",\n \"np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] =\",\n \"None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent\",\n \"= self.source_id photon.id = self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin,\",\n \"use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon =\",\n \"wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin\",\n \"= 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum\",\n \"self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\" +\",\n \"aligned with the z-axis. For this lense an additional z-boost is added (Angle\",\n \"0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else:\",\n \"= thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self): photon\",\n \"photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id\",\n \"self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z)\",\n \"rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This method of calculating\",\n \"the surface of the finite plane in it's local frame x = np.random.uniform(0.,\",\n \"LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated in a plane are focused on\",\n \"= np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction\",\n \"photon class Laser(object): \\\"\\\"\\\"A light source that will generate photons of a single\",\n \"self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source\",\n \"= 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum\",\n \"finite plane in it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0.,\",\n \"the top surface (normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1),\",\n \"self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw\",\n \"np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace import\",\n \"in solid angle specified by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum =\",\n \"FinitePlane(length=length, width=width) self.length = length self.width = width # direction is the direction\",\n \"np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform\",\n \"set generate a random polarisation vector of the photon if self.use_random_polarisation: # Randomise\",\n \"photon.direction = direction photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())\",\n \"self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum != None: photon.wavelength =\",\n \"with the z-axis. For this lense an additional z-boost is added (Angle of\",\n \"inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta =\",\n \"super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin =\",\n \"self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1)\",\n \"= Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1\",\n \"along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np from\",\n \"it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point =\",\n \"Photon() photon.id = self.throw self.throw = self.throw + 1 # Position x =\",\n \"direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction\",\n \"= np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1]\",\n \"be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y =\",\n \"= self.throw + 1 # Create a point which is on the surface\",\n \"(no need to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta\",\n \"self.shape.transform) # Direction of emission (no need to transform if meant to be\",\n \"r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center\",\n \"0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__()\",\n \"focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position\",\n \"planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin =\",\n \"solid angle specified by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum = None,\",\n \"General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. import\",\n \"of the plane in the GLOBAL FRAME. # i.e. this is passed directly\",\n \"np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that will generate photons of a single\",\n \"(Angle of incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength =\",\n \"self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize\",\n \"super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent =\",\n \"\\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw =\",\n \"# Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position =\",\n \"vectors is taken from GNU Scientific Library LOOP = True while LOOP: x\",\n \"photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from +z\",\n \"boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction\",\n \"the GNU General Public License as published by # the Free Software Foundation;\",\n \"vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1])\",\n \"in a plane are focused on a line with space tolerance given by\",\n \"= np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id =\",\n \"self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta\",\n \"str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction\",\n \"photons generated in a plane are focused on a line with space tolerance\",\n \"= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A source\",\n \"and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position\",\n \"wavelength = 555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum =\",\n \"self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self):\",\n \"+ boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus\",\n \"by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555,\",\n \"= length) self.radius = radius self.length = length self.throw = 0 self.source_id =\",\n \"not set.\\\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\" + str(id(self))\",\n \"= 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength\",\n \"= position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw =\",\n \"self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width # direction is\",\n \"of a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False):\",\n \"the plane normal and aligned with the z-axis. For this lense an additional\",\n \"= np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \\\"LensSource_\\\" + str(id(self))\",\n \"generate photons of a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1],\",\n \"phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource,\",\n \"else: photon.wavelength = self.wavelength # Further initialisation photon.active = True return photon class\",\n \"= self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength =\",\n \"direction photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength\",\n \"y = a * y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that\",\n \"# Further initialisation photon.active = True return photon class PointSource(object): \\\"\\\"\\\" A point\",\n \"direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\"\",\n \"= (x, y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction\",\n \"transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw = self.throw +\",\n \"self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A source where\",\n \"the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum =\",\n \"it will be useful, # but WITHOUT ANY WARRANTY; without even the implied\",\n \"\\\"\\\"\\\" A source for photons emitted in a random direction and position inside\",\n \"photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 phi =\",\n \"Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy\",\n \"xy-plane, the transform from +z to the direction of the photon vec =\",\n \"self.throw = 0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self): photon = Photon()\",\n \"a point which is on the surface of the finite plane in it's\",\n \"return photon class Laser(object): \\\"\\\"\\\"A light source that will generate photons of a\",\n \"y**2 if s <= 1.0: LOOP = False z = -1. + 2.\",\n \"555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength\",\n \"a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource,\",\n \"= np.array(direction) self.wavelength = wavelength assert polarisation != None, \\\"Polarisation of the Laser\",\n \"be perpendicular to the plane normal and aligned with the z-axis. For this\",\n \"i.e. this is passed directly to the photon to set is's direction self.direction\",\n \"= np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center =\",\n \"if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from +z to\",\n \"10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius =\",\n \"the # GNU General Public License for more details. # # You should\",\n \"..., thetamax \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center =\",\n \"True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw\",\n \"external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace import Photon from\",\n \"transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This method of\",\n \"def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength\",\n \"= np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the direciton photon.position\",\n \"= spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length = length)\",\n \"super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent =\",\n \"555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0,\",\n \"else: photon.polarisation = None photon.id = self.throw self.throw = self.throw + 1 return\",\n \"__init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction\",\n \"generate a random polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation\",\n \"# the Free Software Foundation; either version 3 of the License, or #\",\n \"super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length\",\n \"Free Software Foundation; either version 3 of the License, or # (at your\",\n \"photons of a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555,\",\n \"specified by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength =\",\n \"and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position)\",\n \"self.throw = self.throw + 1 # Position of emission phi = np.random.uniform(0., 2*np.pi)\",\n \"wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection)\",\n \"plane are focused on a line with space tolerance given by variable \\\"focussize\\\".\",\n \"norm from Materials import Spectrum def random_spherecial_vector(): # This method of calculating isotropic\",\n \"PARTICULAR PURPOSE. See the # GNU General Public License for more details. #\",\n \"a random polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation angle\",\n \"2. * np.random.uniform() y = -1. + 2. * np.random.uniform() s = x**2\",\n \"PlanarSource(object): \\\"\\\"\\\"A box that emits photons from the top surface (normal), sampled from\",\n \"= np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of photon\",\n \"width # direction is the direction that photons are fired out of the\",\n \"free software; you can redistribute it and/or modify # it under the terms\",\n \"focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum =\",\n \"0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum\",\n \"useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of #\",\n \"axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =\",\n \"x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position\",\n \"on the surface of the finite plane in it's local frame x =\",\n \"the GLOBAL FRAME. # i.e. this is passed directly to the photon to\",\n \"even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\",\n \"= \\\"PointSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id\",\n \"self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta)\",\n \"= spectrum self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax =\",\n \"photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi =\",\n \"direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength\",\n \"= phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id =\",\n \"from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import\",\n \"1 # Create a point which is on the surface of the finite\",\n \"= False z = -1. + 2. * s a = 2 *\",\n \"phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi)\",\n \"None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active =\",\n \"photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active\",\n \"incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0),\",\n \"__init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin = 0,\",\n \"y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that will generate photons of\",\n \"discrete angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength =\",\n \"added (Angle of incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength\",\n \"focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction =\",\n \"colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position\",\n \"vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec,\",\n \"pvtrace is distributed in the hope that it will be useful, # but\",\n \"= photon.position[2] + boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction\",\n \"np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction\",\n \"polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane,\",\n \"local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of photon if self.spectrum\",\n \"translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon()\",\n \"photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 # Create\",\n \"to the plane normal and aligned with the z-axis. For this lense an\",\n \"photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active = True\",\n \"= 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source\",\n \"= length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation):\",\n \"= radius self.length = length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self))\",\n \"radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength =\",\n \"at discrete angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength\",\n \"photon.active = True photon.wavelength = self.wavelength # If use_polarisation is set generate a\",\n \"np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint\",\n \"import external.transformations as tf from Trace import Photon from Geometry import Box, Cylinder,\",\n \"r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction\",\n \"is not set.\\\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\" +\",\n \"planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength =\",\n \"self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1)\",\n \"= self.throw + 1 return photon class PlanarSource(object): \\\"\\\"\\\"A box that emits photons\",\n \"Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): #\",\n \"= wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self))\",\n \"= focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if\",\n \"terms of the GNU General Public License as published by # the Free\",\n \"Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm\",\n \"self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax\",\n \"emits randomly in solid angle specified by phimin, ..., thetamax \\\"\\\"\\\" def __init__(self,\",\n \"Create a point which is on the surface of the finite plane in\",\n \"aligned with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555,\",\n \"as tf from Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point,\",\n \"source that emits at discrete angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum\",\n \"return photon class PointSource(object): \\\"\\\"\\\" A point source that emits randomly in solid\",\n \"<http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as\",\n \"thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center =\",\n \"x = -1. + 2. * np.random.uniform() y = -1. + 2. *\",\n \"with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0),\",\n \"= True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength\",\n \"= 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength\",\n \"# Create a point which is on the surface of the finite plane\",\n \"\\\"LensSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =\",\n \"space tolerance given by variable \\\"focussize\\\". The focus line should be perpendicular to\",\n \"= FinitePlane(length=length, width=width) self.length = length self.width = width # direction is the\",\n \"= True while LOOP: x = -1. + 2. * np.random.uniform() y =\",\n \"self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length =\",\n \"self.angle = angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self):\",\n \"photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw =\",\n \"phimin, ..., thetamax \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center\",\n \"True return photon class PointSource(object): \\\"\\\"\\\" A point source that emits randomly in\",\n \"that emits at discrete angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum =\",\n \"self.source_id photon.id = self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax)\",\n \"surface of the finite plane in it's local frame x = np.random.uniform(0., self.length)\",\n \"x**2 + y**2 if s <= 1.0: LOOP = False z = -1.\",\n \"np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z)\",\n \"The focus line should be perpendicular to the plane normal and aligned with\",\n \"= self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi = np.random.randint(1,\",\n \"and aligned with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength =\",\n \"wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =\",\n \"= np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw =\",\n \"= self.wavelength # If use_polarisation is set generate a random polarisation vector of\",\n \"self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width\",\n \"ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR\",\n \"= self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost\",\n \"the plane in the GLOBAL FRAME. # i.e. this is passed directly to\",\n \"source where photons generated in a plane are focused on a line with\",\n \"self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation\",\n \"WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS\",\n \"photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength #\",\n \"# # You should have received a copy of the GNU General Public\",\n \"source that will generate photons of a single colour, direction and position.\\\"\\\"\\\" def\",\n \"= planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw =\",\n \"2. * np.random.uniform() s = x**2 + y**2 if s <= 1.0: LOOP\",\n \"and aligned with the z-axis. For this lense an additional z-boost is added\",\n \"modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength\",\n \"a random direction and position inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum\",\n \"else: photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object): \\\"\\\"\\\" A\",\n \"Public License for more details. # # You should have received a copy\",\n \"direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum\",\n \"self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent\",\n \"self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object): \\\"\\\"\\\"\",\n \"photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A\",\n \"= self.throw self.throw = self.throw + 1 return photon class PlanarSource(object): \\\"\\\"\\\"A box\",\n \"self.direction photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength\",\n \"set.\\\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def\",\n \"line should be perpendicular to the plane normal and aligned with the z-axis.\",\n \"self.length = length self.width = width # direction is the direction that photons\",\n \"photon class RadialSource(object): \\\"\\\"\\\" A point source that emits at discrete angles theta(i)\",\n \"for photons emitted in a random direction and position inside a cylinder(radius, length)\",\n \"np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center,\",\n \"+ np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction\",\n \"self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source\",\n \"= True return photon class RadialSource(object): \\\"\\\"\\\" A point source that emits at\",\n \"out of the plane in the GLOBAL FRAME. # i.e. this is passed\",\n \"return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that will generate photons of a\",\n \"= 2 * np.sqrt(1 - s) x = a * x y =\",\n \"rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw\",\n \"that will generate photons of a single colour, direction and position.\\\"\\\"\\\" def __init__(self,\",\n \"colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position\",\n \"self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length\",\n \"= \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position\",\n \"rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"= \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle,\",\n \"phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y =\",\n \"1 return photon class PlanarSource(object): \\\"\\\"\\\"A box that emits photons from the top\",\n \"np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z =\",\n \"else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A source for photons\",\n \"None, wavelength = 555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum\",\n \"= self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x\",\n \"self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None, \\\"Polarisation of the\",\n \"focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum =\",\n \"from the top surface (normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555,\",\n \"else: photon.wavelength = self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A source where photons\",\n \"= 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon = Photon() photon.id\",\n \"top surface (normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05,\",\n \"np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def\",\n \"= rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id =\",\n \"= (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need to\",\n \"= x**2 + y**2 if s <= 1.0: LOOP = False z =\",\n \"self.throw = 0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon = Photon()\",\n \"phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z\",\n \"focussize self.throw = 0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self): photon =\",\n \"that emits photons from the top surface (normal), sampled from the spectrum.\\\"\\\"\\\" def\",\n \"not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix import\",\n \"\\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize =\",\n \"length) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, radius = 1,\",\n \"vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation\",\n \"transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def random_spherecial_vector(): # This method\",\n \"None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\"\",\n \"numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from\",\n \"0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source =\",\n \"0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source =\",\n \"!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return\",\n \"photon.wavelength = self.wavelength photon.active = True return photon class RadialSource(object): \\\"\\\"\\\" A point\",\n \"focus line should be perpendicular to the plane normal and aligned with the\",\n \"photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength\",\n \"is on the surface of the finite plane in it's local frame x\",\n \"WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A\",\n \"z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.))\",\n \"that it will be useful, # but WITHOUT ANY WARRANTY; without even the\",\n \"= np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center\",\n \"the finite plane in it's local frame x = np.random.uniform(0., self.length) y =\",\n \"be perpendicular to the plane normal and aligned with the z-axis. \\\"\\\"\\\" def\",\n \"wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width = width # direction\",\n \"photon.wavelength = self.wavelength # Further initialisation photon.active = True return photon class PointSource(object):\",\n \"+ str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position)\",\n \"implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\",\n \"\\\"RadialSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =\",\n \"= np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta)\",\n \"+ 1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius)\",\n \"def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw =\",\n \"radius, length = length) self.radius = radius self.length = length self.throw = 0\",\n \"This method of calculating isotropic vectors is taken from GNU Scientific Library LOOP\",\n \"the hope that it will be useful, # but WITHOUT ANY WARRANTY; without\",\n \"np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength of photon if\",\n \"True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return\",\n \"planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize\",\n \"= self.throw + 1 return photon class Laser(object): \\\"\\\"\\\"A light source that will\",\n \"source for photons emitted in a random direction and position inside a cylinder(radius,\",\n \"\\\"\\\"\\\" A point source that emits randomly in solid angle specified by phimin,\",\n \"+ 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta)\",\n \"= np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0]\",\n \"photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A\",\n \"linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum\",\n \"np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set wavelength\",\n \"!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object):\",\n \"a copy of the GNU General Public License # along with this program.\",\n \"self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id\",\n \"x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction\",\n \"= a * x y = a * y return np.array([x,y,z]) class SimpleSource(object):\",\n \"A PARTICULAR PURPOSE. See the # GNU General Public License for more details.\",\n \"Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi)\",\n \"0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source =\",\n \"# This method of calculating isotropic vectors is taken from GNU Scientific Library\",\n \"RadialSource(object): \\\"\\\"\\\" A point source that emits at discrete angles theta(i) and phi(i)\",\n \"polarisation != None, \\\"Polarisation of the Laser is not set.\\\" self.polarisation = np.array(polarisation)\",\n \"the Free Software Foundation; either version 3 of the License, or # (at\",\n \"y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint =\",\n \"return photon class LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated in a plane\",\n \"photon(self): photon = Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction)\",\n \"= self.polarisation photon.id = self.throw self.throw = self.throw + 1 return photon class\",\n \"frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y,\",\n \"class LensSource(object): \\\"\\\"\\\" A source where photons generated in a plane are focused\",\n \"(x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position =\",\n \"point = transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum !=\",\n \"published by # the Free Software Foundation; either version 3 of the License,\",\n \"= -1. + 2. * np.random.uniform() y = -1. + 2. * np.random.uniform()\",\n \"the Laser is not set.\\\" self.polarisation = np.array(polarisation) self.throw = 0 self.source_id =\",\n \"self.wavelength # Further initialisation photon.active = True return photon class PointSource(object): \\\"\\\"\\\" A\",\n \"False z = -1. + 2. * s a = 2 * np.sqrt(1\",\n \"self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"= planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle =\",\n \"License # along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as\",\n \"= r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position =\",\n \"width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width)\",\n \"= 555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin =\",\n \"0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon = Photon() photon.id =\",\n \"+ 1 # Create a point which is on the surface of the\",\n \"around xy-plane, the transform from +z to the direction of the photon vec\",\n \"(x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need to transform\",\n \"np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None, \\\"Polarisation of\",\n \"a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser,\",\n \"in z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1),\",\n \"self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None,\",\n \"is passed directly to the photon to set is's direction self.direction = direction\",\n \"self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon = Photon() photon.id = self.throw\",\n \"= length self.width = width # direction is the direction that photons are\",\n \"= phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw =\",\n \"photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation is\",\n \"software; you can redistribute it and/or modify # it under the terms of\",\n \"emits at discrete angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None,\",\n \"photon.polarisation = None photon.id = self.throw self.throw = self.throw + 1 return photon\",\n \"np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position modulus =\",\n \"wavelength self.shape = Cylinder(radius = radius, length = length) self.radius = radius self.length\",\n \"1.0: LOOP = False z = -1. + 2. * s a =\",\n \"\\\"Polarisation of the Laser is not set.\\\" self.polarisation = np.array(polarisation) self.throw = 0\",\n \"plane normal and aligned with the z-axis. For this lense an additional z-boost\",\n \"LOOP: x = -1. + 2. * np.random.uniform() y = -1. + 2.\",\n \"self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class\",\n \"np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint -\",\n \"perpendicular to the plane normal and aligned with the z-axis. For this lense\",\n \"self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x =\",\n \"General Public License for more details. # # You should have received a\",\n \"np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] =\",\n \"self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta\",\n \"external.transformations as tf from Trace import Photon from Geometry import Box, Cylinder, FinitePlane,\",\n \"CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted in a random direction and position\",\n \"direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.plane =\",\n \"LOOP = True while LOOP: x = -1. + 2. * np.random.uniform() y\",\n \"the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See\",\n \"angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id\",\n \"# If use_polarisation is set generate a random polarisation vector of the photon\",\n \"555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource,\",\n \"light source that will generate photons of a single colour, direction and position.\\\"\\\"\\\"\",\n \"passed directly to the photon to set is's direction self.direction = direction self.throw\",\n \"R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id\",\n \"line with space tolerance given by variable \\\"focussize\\\". The focus line should be\",\n \"y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction\",\n \"Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 intphi\",\n \"a plane are focused on a line with space tolerance given by variable\",\n \"photon.direction = self.direction photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())\",\n \"= None, wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax =\",\n \"!= None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object):\",\n \"position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction\",\n \"= direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength\",\n \"(at your option) any later version. # # pvtrace is distributed in the\",\n \"= thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\" + str(id(self))\",\n \"self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax)\",\n \"more details. # # You should have received a copy of the GNU\",\n \"z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform)\",\n \"GNU General Public License for more details. # # You should have received\",\n \"1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if\",\n \"under the terms of the GNU General Public License as published by #\",\n \"= self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] +\",\n \"= \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle,\",\n \"= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A source\",\n \"transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum != None: photon.wavelength\",\n \"def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon\",\n \"np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] +\",\n \"self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A source for\",\n \"it under the terms of the GNU General Public License as published by\",\n \"Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] +\",\n \"you can redistribute it and/or modify # it under the terms of the\",\n \"transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum != None: photon.wavelength\",\n \"np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center\",\n \"of the License, or # (at your option) any later version. # #\",\n \"position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength\",\n \"hope that it will be useful, # but WITHOUT ANY WARRANTY; without even\",\n \"perpendicular to the plane normal and aligned with the z-axis. \\\"\\\"\\\" def __init__(self,\",\n \"x = a * x y = a * y return np.array([x,y,z]) class\",\n \"is set generate a random polarisation vector of the photon if self.use_random_polarisation: #\",\n \"+ 2. * s a = 2 * np.sqrt(1 - s) x =\",\n \"# Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength\",\n \"y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position =\",\n \"photon class LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated in a plane are\",\n \"photon class CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted in a random direction\",\n \"[0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None photon.id = self.throw self.throw\",\n \"see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations\",\n \"self.polarisation photon.id = self.throw self.throw = self.throw + 1 return photon class PlanarSource(object):\",\n \"= wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection =\",\n \"np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation\",\n \"focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum\",\n \"of emission (no need to transform if meant to be isotropic) phi =\",\n \"(x, y, 0.) # Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction =\",\n \"= Photon() photon.source = self.source_id photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active =\",\n \"= wavelength assert polarisation != None, \\\"Polarisation of the Laser is not set.\\\"\",\n \"0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center\",\n \"self.throw self.throw = self.throw + 1 return photon class PlanarSource(object): \\\"\\\"\\\"A box that\",\n \"self.spectrum = spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length\",\n \"1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z\",\n \"# direction is the direction that photons are fired out of the plane\",\n \"direction of the photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec)\",\n \"self.throw self.throw = self.throw + 1 # Create a point which is on\",\n \"= transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum != None:\",\n \"1 return photon class Laser(object): \\\"\\\"\\\"A light source that will generate photons of\",\n \"spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize =\",\n \"photon.wavelength = self.wavelength # If use_polarisation is set generate a random polarisation vector\",\n \"vector of the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the\",\n \"self.thetamax = thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def photon(self):\",\n \"License as published by # the Free Software Foundation; either version 3 of\",\n \"* s a = 2 * np.sqrt(1 - s) x = a *\",\n \"be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of\",\n \"np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position\",\n \"planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength =\",\n \"self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted in a\",\n \"y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform)\",\n \"plane normal and aligned with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None,\",\n \"import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials import Spectrum def\",\n \"spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius, length = length) self.radius\",\n \"self.width = width # direction is the direction that photons are fired out\",\n \"normal and aligned with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength\",\n \"to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi)\",\n \"GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>.\",\n \"np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0]\",\n \"boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] +\",\n \"directly to the photon to set is's direction self.direction = direction self.throw =\",\n \"focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint\",\n \"self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi =\",\n \"thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\"\",\n \"= np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center =\",\n \"thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength =\",\n \"= -1. + 2. * s a = 2 * np.sqrt(1 - s)\",\n \"are focused on a line with space tolerance given by variable \\\"focussize\\\". The\",\n \"that photons are fired out of the plane in the GLOBAL FRAME. #\",\n \"= self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position x\",\n \"Laser(object): \\\"\\\"\\\"A light source that will generate photons of a single colour, direction\",\n \"+ str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw\",\n \"but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or\",\n \"and position inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength\",\n \"np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction = (x,y,z) transform = tf.translation_matrix((0,0,0))\",\n \"= 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum\",\n \"self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z =\",\n \"np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z)\",\n \"= np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0 self.source_id =\",\n \"0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source =\",\n \"np.sqrt(1 - s) x = a * x y = a * y\",\n \"np.pi): super(PointSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center = center self.phimin\",\n \"emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y =\",\n \"plane in it's local frame x = np.random.uniform(0., self.length) y = np.random.uniform(0., self.width)\",\n \"direction and position inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum = None,\",\n \"np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw\",\n \"= self.throw self.throw = self.throw + 1 intphi = np.random.randint(1, self.spacing+1) inttheta =\",\n \"is free software; you can redistribute it and/or modify # it under the\",\n \"= planeorigin self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize =\",\n \"+ 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle)\",\n \"by variable \\\"focussize\\\". The focus line should be perpendicular to the plane normal\",\n \"self.throw = self.throw + 1 return photon class PlanarSource(object): \\\"\\\"\\\"A box that emits\",\n \"+ 2. * np.random.uniform() s = x**2 + y**2 if s <= 1.0:\",\n \"photon.id = self.throw self.throw = self.throw + 1 # Create a point which\",\n \"spectrum self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax = phimax\",\n \"else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta)\",\n \"Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 phi\",\n \"GNU Scientific Library LOOP = True while LOOP: x = -1. + 2.\",\n \"= np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction =\",\n \"\\\"PointSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =\",\n \"variable \\\"focussize\\\". The focus line should be perpendicular to the plane normal and\",\n \"self.throw self.throw = self.throw + 1 return photon class Laser(object): \\\"\\\"\\\"A light source\",\n \"= random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation\",\n \"= self.throw self.throw = self.throw + 1 # Position of emission phi =\",\n \"s <= 1.0: LOOP = False z = -1. + 2. * s\",\n \"this is passed directly to the photon to set is's direction self.direction =\",\n \"direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =\",\n \"None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon\",\n \"direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation))\",\n \"the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if\",\n \"theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction\",\n \"self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \\\"LensSource_\\\" +\",\n \"planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle\",\n \"theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center\",\n \"If not, see <http://www.gnu.org/licenses/>. import numpy as np from external.transformations import translation_matrix, rotation_matrix\",\n \"self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z =\",\n \"= spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width\",\n \"= \\\"LensSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id\",\n \"self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw\",\n \"self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon = Photon()\",\n \"photon(self): photon = Photon() photon.id = self.throw self.throw = self.throw + 1 #\",\n \"have received a copy of the GNU General Public License # along with\",\n \"angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555,\",\n \"= direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id =\",\n \"self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis):\",\n \"theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta)\",\n \"y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint =\",\n \"self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost\",\n \"0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle,\",\n \"photons are fired out of the plane in the GLOBAL FRAME. # i.e.\",\n \"set is's direction self.direction = direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\" +\",\n \"in the GLOBAL FRAME. # i.e. this is passed directly to the photon\",\n \"spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax\",\n \"wavelength self.use_random_polarisation = use_random_polarisation self.throw = 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def\",\n \"option) any later version. # # pvtrace is distributed in the hope that\",\n \"pvtrace is free software; you can redistribute it and/or modify # it under\",\n \"# Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1]\",\n \"= Photon() photon.id = self.throw self.throw = self.throw + 1 # Position x\",\n \"self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.) # Transform the\",\n \"A source where photons generated in a plane are focused on a line\",\n \"= 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__()\",\n \"phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20):\",\n \"is the direction that photons are fired out of the plane in the\",\n \"the z-axis. For this lense an additional z-boost is added (Angle of incidence\",\n \"focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5\",\n \"Software Foundation; either version 3 of the License, or # (at your option)\",\n \"photon.id = self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta\",\n \"sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__()\",\n \"s) x = a * x y = a * y return np.array([x,y,z])\",\n \"PURPOSE. See the # GNU General Public License for more details. # #\",\n \"= 555, radius = 1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum\",\n \"= self.wavelength photon.active = True return photon class RadialSource(object): \\\"\\\"\\\" A point source\",\n \"self.throw = 0 self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon = Photon()\",\n \"np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no\",\n \"# pvtrace is free software; you can redistribute it and/or modify # it\",\n \"self.throw = self.throw + 1 return photon class Laser(object): \\\"\\\"\\\"A light source that\",\n \"self.polarisation = np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self):\",\n \"self.direction = direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self,\",\n \"self.center = center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax\",\n \"= \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position\",\n \"random direction and position inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum =\",\n \"= a * y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source that will\",\n \"= self.throw self.throw = self.throw + 1 phi = np.random.uniform(self.phimin, self.phimax) theta =\",\n \"= \\\"LensSourceAngle_\\\" + str(id(self)) def photon(self): photon = Photon() photon.id = self.throw self.throw\",\n \"import Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors is taken\",\n \"photon to set is's direction self.direction = direction self.throw = 0 self.source_id =\",\n \"= None, wavelength = 555, radius = 1, length = 10): super(CylindricalSource, self).__init__()\",\n \"z = -1. + 2. * s a = 2 * np.sqrt(1 -\",\n \"any later version. # # pvtrace is distributed in the hope that it\",\n \"x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) -\",\n \"self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\" +\",\n \"photon.active = True photon.wavelength = self.wavelength photon.polarisation = self.polarisation photon.id = self.throw self.throw\",\n \"the GNU General Public License # along with this program. If not, see\",\n \"photons from the top surface (normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None,\",\n \"np.array(direction) self.wavelength = wavelength assert polarisation != None, \\\"Polarisation of the Laser is\",\n \"Library LOOP = True while LOOP: x = -1. + 2. * np.random.uniform()\",\n \"a line with space tolerance given by variable \\\"focussize\\\". The focus line should\",\n \"photon.polarisation = self.polarisation photon.id = self.throw self.throw = self.throw + 1 return photon\",\n \"of the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform\",\n \"= self.wavelength return photon class CylindricalSource(object): \\\"\\\"\\\" A source for photons emitted in\",\n \"details. # # You should have received a copy of the GNU General\",\n \"single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__()\",\n \"box that emits photons from the top surface (normal), sampled from the spectrum.\\\"\\\"\\\"\",\n \"import numpy as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf\",\n \"= np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction # Set\",\n \"self.wavelength return photon class LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated in a\",\n \"= np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin\",\n \"class Laser(object): \\\"\\\"\\\"A light source that will generate photons of a single colour,\",\n \"random polarisation vector of the photon if self.use_random_polarisation: # Randomise rotation angle around\",\n \"is added (Angle of incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None,\",\n \"= True photon.wavelength = self.wavelength # If use_polarisation is set generate a random\",\n \"length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape =\",\n \"(x,y,z) photon.direction = local_direction # Set wavelength of photon if self.spectrum != None:\",\n \"self.spacing = spacing self.throw = 0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self):\",\n \"= np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction =\",\n \"np.random.randint(1, self.spacing+1) inttheta = np.random.randint(1, self.spacing+1) phi = intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax:\",\n \"if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x =\",\n \"point source that emits randomly in solid angle specified by phimin, ..., thetamax\",\n \"self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1])\",\n \"photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize)\",\n \"= np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.))\",\n \"spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength\",\n \"use_random_polarisation=False): super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation\",\n \"and phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center =\",\n \"= tf.translation_matrix((0,0,0)) point = transform_point(self.center, transform) photon.direction = direction photon.position = point if\",\n \"= self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint -\",\n \"self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw\",\n \"of a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None):\",\n \"position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength\",\n \"__init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize\",\n \"polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert\",\n \"= np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2]\",\n \"# GNU General Public License for more details. # # You should have\",\n \"taken from GNU Scientific Library LOOP = True while LOOP: x = -1.\",\n \"- photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum !=\",\n \"direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength =\",\n \"self.throw = 0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self): photon = Photon()\",\n \"= self.wavelength # Further initialisation photon.active = True return photon class PointSource(object): \\\"\\\"\\\"\",\n \"str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw\",\n \"it and/or modify # it under the terms of the GNU General Public\",\n \"assert polarisation != None, \\\"Polarisation of the Laser is not set.\\\" self.polarisation =\",\n \"np.random.uniform() s = x**2 + y**2 if s <= 1.0: LOOP = False\",\n \"= np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y = r*np.sin(phi) z\",\n \"* x y = a * y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light\",\n \"def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction =\",\n \"self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw\",\n \"= -1. + 2. * np.random.uniform() s = x**2 + y**2 if s\",\n \"as published by # the Free Software Foundation; either version 3 of the\",\n \"= np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0]\",\n \"phi(i) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.),\",\n \"isotropic vectors is taken from GNU Scientific Library LOOP = True while LOOP:\",\n \"the transform from +z to the direction of the photon vec = random_spherecial_vector()\",\n \"A source for photons emitted in a random direction and position inside a\",\n \"# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General\",\n \"0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle,\",\n \"photon.active = True if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =\",\n \"self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent = planeextent self.linepoint\",\n \"self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id\",\n \"direction self.direction = direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def\",\n \"norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R) else: photon.polarisation = None\",\n \"If use_polarisation is set generate a random polarisation vector of the photon if\",\n \"local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of emission (no need\",\n \"intphi*(self.phimax-self.phimin)/self.spacing if self.thetamin == self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x\",\n \"= center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax =\",\n \"self).__init__() self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation\",\n \"are fired out of the plane in the GLOBAL FRAME. # i.e. this\",\n \"the photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R =\",\n \"thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength\",\n \"Direction of emission (no need to transform if meant to be isotropic) phi\",\n \"np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength # If use_polarisation\",\n \"= self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active = True return\",\n \"= (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin\",\n \"= 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction, [0,0,1]) photon.polarisation = transform_direction(vec, R)\",\n \"self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction =\",\n \"x y = a * y return np.array([x,y,z]) class SimpleSource(object): \\\"\\\"\\\"A light source\",\n \"# Set wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else:\",\n \"= (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength =\",\n \"np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction =\",\n \"= 0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source\",\n \"Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength return\",\n \"z-boost is added (Angle of incidence in z-direction). \\\"\\\"\\\" def __init__(self, spectrum =\",\n \"np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) #\",\n \"= self.source_id photon.id = self.throw self.throw = self.throw + 1 # Position of\",\n \"focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2]\",\n \"np.array(polarisation) self.throw = 0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon =\",\n \"__init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum self.wavelength =\",\n \"* np.random.uniform() y = -1. + 2. * np.random.uniform() s = x**2 +\",\n \"def __init__(self, spectrum = None, wavelength = 555, radius = 1, length =\",\n \"will generate photons of a single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0],\",\n \"s = x**2 + y**2 if s <= 1.0: LOOP = False z\",\n \"the plane normal and aligned with the z-axis. \\\"\\\"\\\" def __init__(self, spectrum =\",\n \"translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon =\",\n \"length) self.radius = radius self.length = length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\"\",\n \"surface (normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05):\",\n \"spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin =\",\n \"0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength\",\n \"emission (no need to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi)\",\n \"self.throw = 0 self.source_id = \\\"LaserSource_\\\" + str(id(self)) def photon(self): photon = Photon()\",\n \"wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin =\",\n \"spectrum self.wavelength = wavelength self.plane = FinitePlane(length=length, width=width) self.length = length self.width =\",\n \"= np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction\",\n \"np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0 self.source_id = \\\"LensSource_\\\"\",\n \"spectrum.\\\"\\\"\\\" def __init__(self, spectrum=None, wavelength=555, direction=(0,0,1), length=0.05, width=0.05): super(PlanarSource, self).__init__() self.spectrum = spectrum\",\n \"or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License\",\n \"self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z =\",\n \"photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None:\",\n \"np.random.uniform(self.phimin, self.phimax) theta = np.random.uniform(self.thetamin, self.thetamax) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z\",\n \"\\\"CylindricalSource_\\\" + str(id(self)) def translate(self, translation): self.shape.append_transform(tf.translation_matrix(translation)) def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis))\",\n \"linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent =\",\n \"photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active = True if self.spectrum !=\",\n \"if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further\",\n \"def __init__(self, spectrum = None, wavelength = 555, center = (0.,0.,0.), phimin =\",\n \"distributed in the hope that it will be useful, # but WITHOUT ANY\",\n \"either version 3 of the License, or # (at your option) any later\",\n \"self.focussize = focussize self.angle = angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" +\",\n \"from Trace import Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment,\",\n \"use_polarisation is set generate a random polarisation vector of the photon if self.use_random_polarisation:\",\n \"def rotate(self, angle, axis): self.plane.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source =\",\n \"of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x = r*np.cos(phi) y\",\n \"photon = Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw +\",\n \"of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength\",\n \"# Transform the direciton photon.position = transform_point(local_point, self.plane.transform) photon.direction = self.direction photon.active =\",\n \"Photon() photon.source = self.source_id photon.id = self.throw self.throw = self.throw + 1 #\",\n \"if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active =\",\n \"need to transform if meant to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta =\",\n \"np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] =\",\n \"calculating isotropic vectors is taken from GNU Scientific Library LOOP = True while\",\n \"while LOOP: x = -1. + 2. * np.random.uniform() y = -1. +\",\n \"= 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)):\",\n \"thetamax = np.pi, spacing=20): super(RadialSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.center\",\n \"\\\"LaserSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id photon.position =\",\n \"= (-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength\",\n \"== self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y\",\n \"emits photons from the top surface (normal), sampled from the spectrum.\\\"\\\"\\\" def __init__(self,\",\n \"0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi): super(PointSource, self).__init__() self.spectrum\",\n \"self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation = use_random_polarisation self.throw\",\n \"= self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z\",\n \"* np.sqrt(1 - s) x = a * x y = a *\",\n \"= self.source_id photon.id = self.throw self.throw = self.throw + 1 # Create a\",\n \"= np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z))\",\n \"is's direction self.direction = direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self))\",\n \"Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z))\",\n \"self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0 self.source_id\",\n \"the photon if self.use_random_polarisation: # Randomise rotation angle around xy-plane, the transform from\",\n \"= None photon.id = self.throw self.throw = self.throw + 1 return photon class\",\n \"photon.position = point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength =\",\n \"2 * np.sqrt(1 - s) x = a * x y = a\",\n \"width=width) self.length = length self.width = width # direction is the direction that\",\n \"self.source_id photon.id = self.throw self.throw = self.throw + 1 # Create a point\",\n \"self.throw = 0 self.source_id = \\\"PlanarSource_\\\" + str(id(self)) def translate(self, translation): self.plane.append_transform(tf.translation_matrix(translation)) def\",\n \"General Public License as published by # the Free Software Foundation; either version\",\n \"self.source_id = \\\"SimpleSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"self.focussize = focussize self.throw = 0 self.source_id = \\\"LensSource_\\\" + str(id(self)) def photon(self):\",\n \"return photon class LensSource(object): \\\"\\\"\\\" A source where photons generated in a plane\",\n \"def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0,\",\n \"np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\"\",\n \"as np from external.transformations import translation_matrix, rotation_matrix import external.transformations as tf from Trace\",\n \"= self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction = focuspoint - photon.position modulus\",\n \"class LensSourceAngle(object): \\\"\\\"\\\" A source where photons generated in a plane are focused\",\n \"rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id\",\n \"(0.,0.,0.), phimin = 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi,\",\n \"= point if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength\",\n \"photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength photon.active = True return photon class\",\n \"\\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle =\",\n \"planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw = 0\",\n \"self.wavelength return photon class LensSource(object): \\\"\\\"\\\" A source where photons generated in a\",\n \"axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source = self.source_id photon.id =\",\n \"from GNU Scientific Library LOOP = True while LOOP: x = -1. +\",\n \"a = 2 * np.sqrt(1 - s) x = a * x y\",\n \"A point source that emits randomly in solid angle specified by phimin, ...,\",\n \"\\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, radius = 1, length\",\n \"self.width) local_point = (x, y, 0.) # Transform the direciton photon.position = transform_point(local_point,\",\n \"from +z to the direction of the photon vec = random_spherecial_vector() vec[2] =\",\n \"def rotate(self, angle, axis): self.shape.append_transform(tf.rotation_matrix(angle, axis)) def photon(self): photon = Photon() photon.source =\",\n \"wavelength self.center = center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin\",\n \"1 # Position of emission phi = np.random.uniform(0., 2*np.pi) r = np.random.uniform(0.,self.radius) x\",\n \"= np.array(position) self.direction = np.array(direction) self.wavelength = wavelength assert polarisation != None, \\\"Polarisation\",\n \"phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\"\",\n \"and/or modify # it under the terms of the GNU General Public License\",\n \"Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors is taken from\",\n \"z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize\",\n \"= focussize self.angle = angle self.throw = 0 self.source_id = \\\"LensSourceAngle_\\\" + str(id(self))\",\n \"z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) # Direction of\",\n \"super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape = Cylinder(radius = radius,\",\n \"single colour, direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, use_random_polarisation=False): super(SimpleSource, self).__init__()\",\n \"= photon.position[2] direction = focuspoint - photon.position modulus = (direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus\",\n \"spectrum = None, wavelength = 555, radius = 1, length = 10): super(CylindricalSource,\",\n \"1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position\",\n \"local_direction # Set wavelength of photon if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())\",\n \"point source that emits at discrete angles theta(i) and phi(i) \\\"\\\"\\\" def __init__(self,\",\n \"where photons generated in a plane are focused on a line with space\",\n \"phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.throw = 0\",\n \"(-1,-1,-1), planeextent = (-1,1,1)): super(LensSourceAngle, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin\",\n \"# pvtrace is distributed in the hope that it will be useful, #\",\n \"self.spectrum.wavelength_at_probability(np.random.uniform()) else: photon.wavelength = self.wavelength # Further initialisation photon.active = True return photon\",\n \"self.thetamax: theta = self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y =\",\n \"np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle = angle self.throw = 0\",\n \"-1. + 2. * s a = 2 * np.sqrt(1 - s) x\",\n \"planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin =\",\n \"z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) photon.position = np.array((x,y,z)) # Direction focuspoint = np.array((0.,0.,0.)) focuspoint[0] =\",\n \"direction and position.\\\"\\\"\\\" def __init__(self, position=[0,0,0], direction=[0,0,1], wavelength=555, polarisation=None): super(Laser, self).__init__() self.position =\",\n \"= wavelength self.shape = Cylinder(radius = radius, length = length) self.radius = radius\",\n \"focuspoint = np.array((0.,0.,0.)) focuspoint[0] = self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize)\",\n \"method of calculating isotropic vectors is taken from GNU Scientific Library LOOP =\",\n \"modify # it under the terms of the GNU General Public License as\",\n \"Further initialisation photon.active = True return photon class PointSource(object): \\\"\\\"\\\" A point source\",\n \"= inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z = np.cos(theta) direction =\",\n \"!= None, \\\"Polarisation of the Laser is not set.\\\" self.polarisation = np.array(polarisation) self.throw\",\n \"= transform_point(self.center, transform) photon.direction = direction photon.position = point if self.spectrum != None:\",\n \"the direction that photons are fired out of the plane in the GLOBAL\",\n \"given by variable \\\"focussize\\\". The focus line should be perpendicular to the plane\",\n \"linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin = (-1,-1,-1), planeextent = (-1,1,1)):\",\n \"0 self.source_id = \\\"RadialSource_\\\" + str(id(self)) def photon(self): photon = Photon() photon.source =\",\n \"phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing self.throw = 0\",\n \"generated in a plane are focused on a line with space tolerance given\",\n \"= 0, phimax = 2*np.pi, thetamin = 0, thetamax = np.pi, spacing=20): super(RadialSource,\",\n \"z-direction). \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle\",\n \"return photon class PlanarSource(object): \\\"\\\"\\\"A box that emits photons from the top surface\",\n \"the z-axis. \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1),\",\n \"phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax self.spacing = spacing\",\n \"See the # GNU General Public License for more details. # # You\",\n \"- s) x = a * x y = a * y return\",\n \"isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta)\",\n \"to set is's direction self.direction = direction self.throw = 0 self.source_id = \\\"PlanarSource_\\\"\",\n \"photon.position = np.array(self.position) photon.direction = np.array(self.direction) photon.active = True photon.wavelength = self.wavelength photon.polarisation\",\n \"__init__(self, spectrum = None, wavelength = 555, radius = 1, length = 10):\",\n \"self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.angle\",\n \"None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0, focussize = 0, planeorigin\",\n \"super(SimpleSource, self).__init__() self.position = position self.direction = direction self.wavelength = wavelength self.use_random_polarisation =\",\n \"(-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin = planeorigin self.planeextent\",\n \"__init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), focussize = 0, planeorigin\",\n \"photon vec = random_spherecial_vector() vec[2] = 0. vec = norm(vec) R = rotation_matrix_from_vector_alignment(self.direction,\",\n \"self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] + boost direction = focuspoint - photon.position\",\n \"Public License as published by # the Free Software Foundation; either version 3\",\n \"<= 1.0: LOOP = False z = -1. + 2. * s a\",\n \"to the direction of the photon vec = random_spherecial_vector() vec[2] = 0. vec\",\n \"= True return photon class PointSource(object): \\\"\\\"\\\" A point source that emits randomly\",\n \"transform from +z to the direction of the photon vec = random_spherecial_vector() vec[2]\",\n \"R) else: photon.polarisation = None photon.id = self.throw self.throw = self.throw + 1\",\n \"center self.phimin = phimin self.phimax = phimax self.thetamin = thetamin self.thetamax = thetamax\",\n \"= y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2]) - boost photon.position = np.array((x,y,z)) # Direction focuspoint\",\n \"Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z = np.random.uniform(self.planeorigin[2],self.planeextent[2])\",\n \"thetamin self.thetamax = thetamax self.throw = 0 self.source_id = \\\"PointSource_\\\" + str(id(self)) def\",\n \"FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more\",\n \"(-1,-1,-1), planeextent = (-1,1,1)): super(LensSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.planeorigin\",\n \"inside a cylinder(radius, length) \\\"\\\"\\\" def __init__(self, spectrum = None, wavelength = 555,\",\n \"self.throw self.throw = self.throw + 1 # Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y =\",\n \"= self.thetamin else: theta = inttheta*(self.thetamax-self.thetamin)/self.spacing x = np.cos(phi)*np.sin(theta) y = np.sin(phi)*np.sin(theta) z\",\n \"to be isotropic) phi = np.random.uniform(0.,2*np.pi) theta = np.random.uniform(0.,np.pi) x = np.cos(phi)*np.sin(theta) y\",\n \"= r*np.sin(phi) z = np.random.uniform(0.,self.length) local_center = (x,y,z) photon.position = transform_point(local_center, self.shape.transform) #\",\n \"def random_spherecial_vector(): # This method of calculating isotropic vectors is taken from GNU\",\n \"Photon from Geometry import Box, Cylinder, FinitePlane, transform_point, transform_direction, rotation_matrix_from_vector_alignment, norm from Materials\",\n \"photons emitted in a random direction and position inside a cylinder(radius, length) \\\"\\\"\\\"\",\n \"photon.id = self.throw self.throw = self.throw + 1 # Position of emission phi\",\n \"self.wavelength = wavelength self.center = center self.phimin = phimin self.phimax = phimax self.thetamin\",\n \"y = np.sin(phi)*np.sin(theta) z = np.cos(theta) local_direction = (x,y,z) photon.direction = local_direction #\",\n \"= self.linepoint[0] + np.random.uniform(-self.focussize,self.focussize) focuspoint[1] = self.linepoint[1] + np.random.uniform(-self.focussize,self.focussize) focuspoint[2] = photon.position[2] direction\",\n \"(direction[0]**2+direction[1]**2+direction[2]**2)**0.5 photon.direction = direction/modulus # Wavelength if self.spectrum != None: photon.wavelength = self.spectrum.wavelength_at_probability(np.random.uniform())\",\n \"# along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy as np\",\n \"= radius, length = length) self.radius = radius self.length = length self.throw =\",\n \"from Materials import Spectrum def random_spherecial_vector(): # This method of calculating isotropic vectors\",\n \"# Position x = np.random.uniform(self.planeorigin[0],self.planeextent[0]) y = np.random.uniform(self.planeorigin[1],self.planeextent[1]) boost = y*np.tan(self.angle) z =\",\n \"# (at your option) any later version. # # pvtrace is distributed in\",\n \"None, wavelength = 555, center = (0.,0.,0.), phimin = 0, phimax = 2*np.pi,\",\n \"= np.random.uniform(0., self.length) y = np.random.uniform(0., self.width) local_point = (x, y, 0.) #\",\n \"SimpleSource(object): \\\"\\\"\\\"A light source that will generate photons of a single colour, direction\",\n \"1, length = 10): super(CylindricalSource, self).__init__() self.spectrum = spectrum self.wavelength = wavelength self.shape\",\n \"def __init__(self, spectrum = None, wavelength = 555, linepoint=(0,0,0), linedirection=(0,0,1), angle = 0,\",\n \"# but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY\",\n \"this lense an additional z-boost is added (Angle of incidence in z-direction). \\\"\\\"\\\"\",\n \"which is on the surface of the finite plane in it's local frame\",\n \"self.length = length self.throw = 0 self.source_id = \\\"CylindricalSource_\\\" + str(id(self)) def translate(self,\",\n \"self.planeextent = planeextent self.linepoint = np.array(linepoint) self.linedirection = np.array(linedirection) self.focussize = focussize self.throw\",\n \"# Randomise rotation angle around xy-plane, the transform from +z to the direction\",\n \"+z to the direction of the photon vec = random_spherecial_vector() vec[2] = 0.\"\n]","isConversational":false}}},{"rowIdx":276,"cells":{"ngram":{"kind":"list like","value":["0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b)","other)]) def nand_(self: bits, other) -> bits: \"\"\" >>> results = [] >>>","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y)","of logic circuits and synthesizing circuits from those definitions. \"\"\" from __future__ import","bits(result) def __pow__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" return self","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self, other):","in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise","nor(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits, other: bits)","bit from the integer 1 \"\"\" if other == 1: return bit.operation(op.not_, self)","0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss =","Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>>","zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ... c","all(results) True \"\"\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\" >>> results","... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","all(results) True \"\"\" return bit.operation(op.and_, self, other) def __and__(self, other): \"\"\" >>> results","output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other)","in zip(self, other)]) def xor(self: bits, other: bits) -> bits: \"\"\" >>> results","for b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>>","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other)","y Traceback (most recent call last): ... RuntimeError: automated circuit synthesis failed \"\"\"","in zip(self, other)]) def or_(self: bits, other: bits) -> bits: \"\"\" >>> results","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) ==","signature class bit(): \"\"\" Class for representing an abstract bit. Such a bit","for (x, y) in zip(self, other)]) def xnor(self: bits, other: bits) -> bits:","\"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits, other:",">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4])","a variable input from one source.\"\"\" class input_two(input): \"\"\"Bit that is designated as","bits: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs","the original function. return f if __name__ == \"__main__\": doctest.testmod() # pragma: no","keep track of relationships between operators and to represent the wires within a","pylint: disable=R0903 \"\"\" Class for representing an input or output type of a","self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is designated","inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z","# it returns an output. if bit._hook_operation is not None: r = bit._hook_operation(o,","bits: \"\"\" Return bits object given the supplied argument. \"\"\" return bits_type(argument)\\ if","** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\"","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >=","\"\"\" return bit.operation(op.imp_, self, other) def nand(self, other): \"\"\" >>> results = []",">>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>>","return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits, other: bits)","1], [0, 0, 0, 0]] \"\"\" if isinstance(other, list) and len(other) > 0","bit.operation(op.and_, self, other) def __and__(self, other): \"\"\" >>> results = [] >>> for","is `other`. def __add__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" result","= output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value,","other)]) def __xor__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","of abstract bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([","bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\"","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns","Return output from hook if it exists and if # it returns an","y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs]","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nand_(y) for","outputs(xs > ys) ... ns = [int(z) for z in zs] ... c","-> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss =","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z)","in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b)","is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args]))","= outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)),","0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y,","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that","the bit by copying it to a new wire. self.value = b.value self.gate","bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0,","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\"","all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\" >>> results",">>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\" >>>","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","circuits from those definitions. \"\"\" from __future__ import annotations from typing import Sequence","True \"\"\" return bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\" >>> results =","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","as final output or whether there are others dependent on it. if len(b.gate.outputs)","y, y, y])) >>> all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in","x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for","outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","= lambda a: output if a is bit else outputs # For forward-compatibility","be interpreted concretely as a value, but it is also used to keep","> ys) ... ns = [int(z) for z in zs] ... c =","output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>>","bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","representing a vector of abstract bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) ->","annotations from typing import Sequence import doctest from parts import parts from circuit","zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ... c","= { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return'","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y)))","other) def __xor__(self, other): \"\"\" >>> results = [] >>> for (x, y)","(x, y) in zip(self, other)]) def nand(self: bits, other) -> bits: \"\"\" >>>","igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate =","1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the integer","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def nand_(self,","outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","other)) # Number of parts is `other`. def __add__(self: bits, other) -> bits:","... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","designated as a variable input from a second source.\"\"\" class output(bit): \"\"\" Bit","type_out = lambda a: output if a is bit else outputs # For","(input_one, input_two)) and b2 is None: return type(b1) else: return bit \"\"\" return","self ^ (constant(other) if isinstance(other, int) else other) def or_(self, other): \"\"\" >>>","for b in bs] [1, 1, 1, 0, 0, 0, 0, 1] \"\"\"","= output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation =","y) in zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \"\"\" >>>","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self,","inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z","... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ...","bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs","in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit())","bs] for bs in bss] [[1, 1], [1, 1], [0, 0], [0, 0]]","combinator library for assembling abstract definitions of logic circuits and synthesizing circuits from","b2=None): # The inference code below is not currently in use. \"\"\" if","y) in zip(self, other)]) def nand(self: bits, other) -> bits: \"\"\" >>> results","0, 0, 0, 0, 0] \"\"\" return bits([ bit_ for byte_ in bytes_","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs < ys) ...","results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys))","returns an output. if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args)","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys) ...","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns =","inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\" Decorator","from those definitions. \"\"\" from __future__ import annotations from typing import Sequence import","bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v,","True \"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results = [] >>>","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs &","x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for","zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \"\"\" >>> results =","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def xnor(self, other):","[b.value for b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0])","other) def imp_(self, other): \"\"\" >>> results = [] >>> for (x, y)","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xor_(y) for (x,","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <= ys)","def imp_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits, other: bits)",">>> all(results) True \"\"\" return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>> results","y, y, y])) >>> all(results) True \"\"\" return bits([x.and_(y) for (x, y) in","\"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits, other:","bit, y: bit) -> bit: ... return (x & y) | ((1 -",">>> results = [] >>> for (x, y) in [(0, 0), (0, 1),","representing an abstract bit. Such a bit can be interpreted concretely as a","y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in","bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>>","Sequence of lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int):","Sequence import doctest from parts import parts from circuit import op, gate, circuit,","bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1,","return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits, other) ->","synthesis failed') from None # Return the original function. return f if __name__","other)]) def nimp_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_,","output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_,","= None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_","} type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None","\"\"\" Decorator for automatically synthesizing a circuit from a function that takes only","0, 0, 0, 0, 0, 0] \"\"\" return bits([ bit_ for byte_ in","type annotation of the decorated function. type_in = lambda a: input(0) if a","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns =","__add__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" result = list(self) result.extend(list(other))","input from one source.\"\"\" class input_two(input): \"\"\"Bit that is designated as a variable","the wires within a circuit built up out of those operators. >>> bit.hook_operation(lambda","for (x, y) in zip(self, other)]) def imp_(self: bits, other: bits) -> bits:","bs in bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \"\"\" if","bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits, other: bits) ->","x])) >>> all(results) True \"\"\" return bits([x.not_() for x in self]) def and_(self:","y])) ... zs = outputs(xs == ys) ... ns = [int(z) for z","used to keep track of relationships between operators and to represent the wires","... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","xor(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","for a in args])) @staticmethod def constructor(b1, b2=None): # The inference code below","\"\"\" return bit.operation(op.or_, self, other) def __or__(self, other): \"\"\" >>> results = []","to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class","return bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ])","x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z)","def and_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits, other: bits) ->","constant input.\"\"\" class input(bit): \"\"\"Bit that is designated as a variable input.\"\"\" def","1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit,","bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def","interpreted concretely as a value, but it is also used to keep track","Decorator for automatically synthesizing a circuit from a function that takes only `bit`","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) &","for (x, y) in zip(self, other)]) def nand(self: bits, other) -> bits: \"\"\"",">>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0 \"\"\" return","bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\" >>> results = [] >>> for","zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \"\"\" >>> results =","zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ... c","\"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits, other:","for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>>","on it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ...","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other) def nif(self, other): \"\"\" >>> results","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y)))","1, 0, 0, 0, 0, 1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0], int):","bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if","bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0)","= output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self,","return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits, other: bits)","(0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1,","abstract definitions of logic circuits and synthesizing circuits from those definitions. \"\"\" from","def __eq__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","call last): ... RuntimeError: automated circuit synthesis failed \"\"\" # Functions for determining","in use. \"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1,","@synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1])","op, gate, circuit, signature class bit(): \"\"\" Class for representing an abstract bit.","from parts import parts from circuit import op, gate, circuit, signature class bit():","zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ... c","quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) **","= output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self,","other) def __and__(self, other): \"\"\" >>> results = [] >>> for (x, y)","for representing a vector of abstract bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit)","other)]) def nor_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","determining types/signature from # the type annotation of the decorated function. type_in =","a is bit else inputs([0] * a) type_out = lambda a: output if","ys) ... ns = [int(z) for z in zs] ... c = bit.circuit()","% input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self,","... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ...","bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\" >>> results = [] >>> for","if # it returns an output. if bit._hook_operation is not None: r =","= outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ... c =","1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","for (x, y) in zip(self, other)]) def __le__(self: bits, other: bits) -> bits:","== 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the","only `bit` and/or `bits` objects as its arguments and returns an output of","(x, y) in zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \"\"\"","bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is designated as a variable input from","\"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs <<","y]) for x in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy)","other) def __lt__(self, other): \"\"\" >>> results = [] >>> for (x, y)","xy in xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2))","others dependent on it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve","other): \"\"\" >>> results = [] >>> for x in [0, 1]: ...","other)]) def imp(self: bits, other: bits) -> bits: \"\"\" >>> results = []","bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\"","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]),","in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in","other) def __mod__(self, other): \"\"\" >>> results = [] >>> for (x, y)","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <= ys) ...","for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1,","... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook >>>","... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in","igs) def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_","bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in ys] [1, 1,","else other) def nimp(self, other): \"\"\" >>> results = [] >>> for (x,","bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\" >>> results = [] >>> for","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\"","1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11,","b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_,","** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs","True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits,","True \"\"\" return bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\" >>> results =",">>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None","input_two)) and b2 is None: return type(b1) else: return bit \"\"\" return bit","\"\"\"Concatenation of bit vectors.\"\"\" return self + other def constants(l): return bits(map(constant, l))",">>> all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def","bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def nand_(self, other):","automated synthesis. \"\"\" class bits(list): \"\"\" Class for representing a vector of abstract","# Number of parts is `other`. def __add__(self: bits, other) -> bits: \"\"\"Concatenation","circuit from a function that takes only `bit` and/or `bits` objects as its","return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits, other: bits)","in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \"\"\" Overloaded operator: rotation","return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits, other: bits)",">>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1,","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys))","True \"\"\" return bits([x.not_() for x in self]) def and_(self: bits, other: bits)","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __ror__(self, other):","outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits,","(0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys]","= hook @staticmethod def operation(o, *args): # Ensure second argument is a `bit`.","bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","def nif_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z","map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other) ==","output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other)","self, other) def imp(self, other): \"\"\" >>> results = [] >>> for (x,","\"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits, other:","b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit())","bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits, other: bits) ->","= bs >> 3 >>> [b.value for b in bs] [0, 0, 0,","bit is ready as final output or whether there are others dependent on","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y) for (x, y)","a bit from the integer 1') def and_(self, other): \"\"\" >>> results =","& input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self,","| constant(0) >>> b.value 1 \"\"\" return self | (constant(other) if isinstance(other, int)","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\"","bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","def if_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","an output. if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if","__new__(cls, argument = None) -> bits: \"\"\" Return bits object given the supplied","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ...","b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def __le__(self, other):","self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\" Class for","other) def imp(self, other): \"\"\" >>> results = [] >>> for (x, y)","y, y])) ... zs = outputs(xs % ys) ... ns = [int(z) for","3, 4]) >>> [[b.value for b in bs] for bs in bss] [[1],","y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self,","bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for","make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a","... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","return bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\" >>> results = [] >>>","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) ==","0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for","bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def","in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0],",">>> [b.value for b in bs] [1, 1, 1, 0, 0, 0, 0,","0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs","b: bit): # Check if bit is ready as final output or whether","= bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results)","bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for","in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b","args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>>","b in bs] [0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit())",">>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \"\"\" def","... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","str) else a # pylint: disable=W0123 try: # Construct the circuit and add","output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other)","output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other)","x, x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys) ... ns","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b)","1, 0] \"\"\" def __init__(self: bit, b: bit): # Check if bit is","x, x]), inputs([y, y, y])) ... zs = outputs(xs >= ys) ... ns","zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ... c","1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \"\"\" Return","0, 1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity =","other)]) def xnor_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","True \"\"\" return bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\" >>> results =","x]) ... ys = outputs(~xs) ... ns = [int(y) for y in ys]","relationships between operators and to represent the wires within a circuit built up","__init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input):",">>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last): ... ValueError:","for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x))","vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits:","code below is not currently in use. \"\"\" if isinstance(b1, input_one) and isinstance(b2,","... xs = inputs([x, x, x]) ... ys = outputs(~xs) ... ns =","b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"",">>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in","(constant(other) if isinstance(other, int) else other) def or_(self, other): \"\"\" >>> results =","def nor_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits:","for b in bs] for bs in bss] [[1, 1], [1, 1], [0,","bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits:","not_(self): \"\"\" >>> results = [] >>> for x in [0, 1]: ...",">>> all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def","True \"\"\" return bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\" >>> results =","input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1)","= output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0]","bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits, other: bits) ->","other) def xnor_(self, other): \"\"\" >>> results = [] >>> for (x, y)","y]) for x in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy)","= outputs(xs ^ ys) ... ns = [int(z) for z in zs] ...","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\"","\"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits, other:","\"\"\" Return bits object given the supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument,","bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other) -> bits: \"\"\"","in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs","zip(self, other)]) def __mod__(self, other) -> bits: \"\"\" >>> results = [] >>>","]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for","__gt__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.if_(y) for (x, y)","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nimp_(y)","... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ...","zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ... c","bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>>","... ns = [int(z) for z in zs] ... c = bit.circuit() ...","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.and_(y) for (x, y)","Embedded domain-specific combinator library for assembling abstract definitions of logic circuits and synthesizing","for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>>","bit._hook_operation(o, v, *args) if r is not None: return r return bit.constructor(*args)(v, bit.gate(o,","[1, 3, 4]) >>> [[b.value for b in bs] for bs in bss]",">>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\" >>>","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns =","self, other) def __eq__(self, other): \"\"\" >>> results = [] >>> for (x,","== input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self,","[a.gate for a in args])) @staticmethod def constructor(b1, b2=None): # The inference code","other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1","nimp_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","\"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_())","bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\" >>> results = [] >>> for","a function that takes only `bit` and/or `bits` objects as its arguments and","RuntimeError: automated circuit synthesis failed \"\"\" # Functions for determining types/signature from #","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns","(x, y) in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \"\"\"","for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n:","1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0,","x, x]), inputs([y, y, y])) ... zs = outputs(xs < ys) ... ns","circuit and add it to the function as an attribute. bit.circuit(circuit()) args_in =","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self,","v, *args) if r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y)))","\"\"\" return self.nimp(other) def nif(self, other): \"\"\" >>> results = [] >>> for","\"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits, other:","1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>> @synthesize","... zs = outputs(xs > ys) ... ns = [int(z) for z in","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >= ys) ...","parts(self, other)) # Number of parts is `other`. def __add__(self: bits, other) ->","return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits:","== 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the","all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self,","outputs(xs <= ys) ... ns = [int(z) for z in zs] ... c","attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if","as a variable input.\"\"\" def __init__(self: bit, value: int): self.value = value self.gate","0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0,","1, 1, 0, 0, 0, 0, 1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0],","# Preserve the bit by copying it to a new wire. self.value =","bits([x.not_() for x in self]) def __invert__(self: bits) -> bits: \"\"\" >>> results","__and__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","0, 0, 0, 0, 0, 0, 0, 0] \"\"\" return bits([ bit_ for","y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in","1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","for (x, y) in zip(self, other)]) def nif_(self: bits, other: bits) -> bits:","4]) >>> [[b.value for b in bs] for bs in bss] [[1], [1,","the value of the result of the operation on the arguments. v =","v = o(*[a.value for a in args]) # Return output from hook if","inputs([y, y, y])) ... zs = outputs(xs & ys) ... ns = [int(z)","1 | constant(0) >>> b.value 1 \"\"\" return self | (constant(other) if isinstance(other,",">>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def","= bit._hook_operation(o, v, *args) if r is not None: return r return bit.constructor(*args)(v,","... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","DSL for assembling logic circuits. Embedded domain-specific combinator library for assembling abstract definitions","| ys) ... ns = [int(z) for z in zs] ... c =","bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0,","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ...","[1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for b in bss[0]],","def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second argument","1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])",">>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\" >>>","in zip(self, other)]) def imp(self: bits, other: bits) -> bits: \"\"\" >>> results","... return x & y Traceback (most recent call last): ... RuntimeError: automated","= outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1] \"\"\" return","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","\"\"\" return bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\" >>> results = []","y, y, y])) >>> all(results) True \"\"\" return bits([x.nand_(y) for (x, y) in","zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ... c","for (x, y) in zip(self, other)]) def or_(self: bits, other: bits) -> bits:","= output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self,","__rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value","-> bits: \"\"\" >>> results = [] >>> for (x, y) in [(0,","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) ==","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def __le__(self,","... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True",">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3}","x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for","1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else:","b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_,","constructor) ]) @staticmethod def zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs","self) raise ValueError('can only subtract a bit from the integer 1') def and_(self,","self, other) def nimp_(self, other): \"\"\" >>> results = [] >>> for (x,","x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) ==","automated circuit synthesis failed \"\"\" # Functions for determining types/signature from # the","True \"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits,","\"\"\"Embedded DSL for assembling logic circuits. Embedded domain-specific combinator library for assembling abstract","\"\"\" Class for representing an abstract bit. Such a bit can be interpreted","bit. Such a bit can be interpreted concretely as a value, but it","def __ge__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nand_(y) for (x, y)","& (constant(other) if isinstance(other, int) else other) def nimp(self, other): \"\"\" >>> results","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys))","not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def","b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __rsub__(self, other):","bs] for bs in bss] [[1], [1, 1, 1], [0, 0, 0, 0]]","# pylint: disable=R0903 \"\"\" Class for representing an input or output type of","None else gate_ def __int__(self): return self.value def not_(self): \"\"\" >>> results =","def __or__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try: # Construct","lambda a: output if a is bit else outputs # For forward-compatibility with","bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>>","= output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self)","= output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \"\"\"","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns","zip(self, other)]) def nif(self: bits, other: bits) -> bits: \"\"\" >>> results =","bits: \"\"\"Concatenation of bit vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self:","bit: ... return (x & y) | ((1 - x) & (1 -","True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits,","bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ...","other)]) def xnor(self: bits, other: bits) -> bits: \"\"\" >>> results = []","1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b","y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in zs]","all(results) True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self:","\"\"\" def __init__(self: bit, b: bit): # Check if bit is ready as","zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \"\"\" >>> results =","bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args):","return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the integer 1')","= constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value of the","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def imp(self, other): \"\"\"","= list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else","one source.\"\"\" class input_two(input): \"\"\"Bit that is designated as a variable input from","function. type_in = lambda a: input(0) if a is bit else inputs([0] *","zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \"\"\" >>> results =","zs = outputs(xs < ys) ... ns = [int(z) for z in zs]","int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift","to keep track of relationships between operators and to represent the wires within","for automated synthesis. \"\"\" class bits(list): \"\"\" Class for representing a vector of","[1, 1, 1], [0, 0, 0, 0]] \"\"\" if isinstance(other, list) and len(other)","0, 0, 0, 0, 0, 0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0) for","list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1]","input.\"\"\" def __init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True)","domain-specific combinator library for assembling abstract definitions of logic circuits and synthesizing circuits","all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self:","if it exists and if # it returns an output. if bit._hook_operation is","Preserve the bit by copying it to a new wire. self.value = b.value","bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) ->","return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l))",">>> def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate","True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits,","class bit(): \"\"\" Class for representing an abstract bit. Such a bit can","= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>> [[b.value","\"\"\"Bit that is designated as a variable input from a second source.\"\"\" class","other) def nimp(self, other): \"\"\" >>> results = [] >>> for (x, y)","in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs,","outputs(xs >= ys) ... ns = [int(z) for z in zs] ... c","= output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self,","input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 -","copying it to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate],",">>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\" >>>","constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value of the result","built up out of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>>","def nand_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","that takes only `bit` and/or `bits` objects as its arguments and returns an","x) & (1 - y)) >>> xys = [bits([x, y]) for x in","for determining types/signature from # the type annotation of the decorated function. type_in","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys))","xnor(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","else inputs([0] * a) type_out = lambda a: output if a is bit","and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length `other`. else:","(xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for x in (0,","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\"","b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def","self, other) def __matmul__(self, other): \"\"\" >>> results = [] >>> for (x,","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ...","[[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x,","type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit","self, other) def xnor(self, other): \"\"\" >>> results = [] >>> for (x,","f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated","1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","y, y])) >>> all(results) True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self,","... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","- input(0) Traceback (most recent call last): ... ValueError: can only subtract a","x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for","and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None:","= output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","last): ... ValueError: can only subtract a bit from the integer 1 \"\"\"","... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ...","[0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs =","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >=","input_one(input): \"\"\"Bit that is designated as a variable input from one source.\"\"\" class","value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is designated as a","a in args]) # Return output from hook if it exists and if","= [int(y) for y in ys] ... c = bit.circuit() ... results.append(ns ==","b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_,","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1], [0, 0,","x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z)",">>> ys = outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1]","isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nimp_(y) for","output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other)","results = [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b","= output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","... zs = outputs(xs | ys) ... ns = [int(z) for z in","y, y])) ... zs = outputs(xs == ys) ... ns = [int(z) for","for assembling logic circuits. Embedded domain-specific combinator library for assembling abstract definitions of","= value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is designated as","def __and__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","y])) ... zs = outputs(xs < ys) ... ns = [int(z) for z","definitions of logic circuits and synthesizing circuits from those definitions. \"\"\" from __future__","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ...","all(results) True \"\"\" return bit.operation(op.if_, self, other) def imp(self, other): \"\"\" >>> results","constant(1) >>> b.value 0 \"\"\" return self & (constant(other) if isinstance(other, int) else","synthesizing circuits from those definitions. \"\"\" from __future__ import annotations from typing import","are others dependent on it. if len(b.gate.outputs) > 0: b = ~(~b) #","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns =","{ k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return' }","def __init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z)","def and_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","bss = list(bs / 2) >>> ([b.value for b in bss[0]], [b.value for","True \"\"\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\" >>> results =",">>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] &","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ...","= output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def imp(self,","x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ...","self, other) def __le__(self, other): \"\"\" >>> results = [] >>> for (x,","y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys))","\"\"\" return self & (constant(other) if isinstance(other, int) else other) def nimp(self, other):","bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for b in","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nor_(y) for (x, y)","x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for","in args])) @staticmethod def constructor(b1, b2=None): # The inference code below is not","xys = [bits([x, y]) for x in (0, 1) for y in (0,","int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is","(most recent call last): ... ValueError: can only subtract a bit from the","b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation = None @staticmethod def","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) class","1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys","y])) >>> all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)])","the type annotation of the decorated function. type_in = lambda a: input(0) if","for z in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x,","for (x, y) in zip(self, other)]) def nif(self: bits, other: bits) -> bits:","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ...","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b)","True \"\"\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\" >>> results =","bits) -> bits: \"\"\" >>> results = [] >>> for (x, y) in","else\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>> xs","all(results) True \"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self:","bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits, other: bits) ->","return map(bits, parts(self, other)) # Number of parts is `other`. def __add__(self: bits,","*args) if r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for","from a second source.\"\"\" class output(bit): \"\"\" Bit that is designated an output.","synthesize(f): \"\"\" Decorator for automatically synthesizing a circuit from a function that takes","on the arguments. v = o(*[a.value for a in args]) # Return output","other) def nimp_(self, other): \"\"\" >>> results = [] >>> for (x, y)","bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\" >>> results = [] >>> for","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ...","bss = list(bs / [1, 3, 4]) >>> [[b.value for b in bs]","PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str) else a #","y)) >>> xys = [bits([x, y]) for x in (0, 1) for y","other) def __gt__(self, other): \"\"\" >>> results = [] >>> for (x, y)","1 \"\"\" return self | (constant(other) if isinstance(other, int) else other) def nor(self,",">>> [[b.value for b in bs] for bs in bss] [[1, 1], [1,","output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_,","y) in zip(self, other)]) def if_(self: bits, other: bits) -> bits: \"\"\" >>>","input or output type of a function decorated for automated synthesis. \"\"\" class","that is designated as a constant input.\"\"\" class input(bit): \"\"\"Bit that is designated","args])) @staticmethod def constructor(b1, b2=None): # The inference code below is not currently","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\"","bits([x.not_() for x in self]) def and_(self: bits, other: bits) -> bits: \"\"\"","bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits, other: bits) ->","for (x, y) in zip(self, other)]) def __mod__(self, other) -> bits: \"\"\" >>>","for x in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for","outputs(xs ^ ys) ... ns = [int(z) for z in zs] ... c","other) def __eq__(self, other): \"\"\" >>> results = [] >>> for (x, y)","> 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths.","2 - input(0) Traceback (most recent call last): ... ValueError: can only subtract","all(results) True \"\"\" return bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\" >>> results","@staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys))",">>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x,",">>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\" >>>","True \"\"\" return bit.operation(op.if_, self, other) def imp(self, other): \"\"\" >>> results =","# For forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if isinstance(a,","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns =","if isinstance(args[1], int) else args[1] # Compute the value of the result of","\"\"\" return self.nif(other) def xor(self, other): \"\"\" >>> results = [] >>> for","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns =","bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\" >>> results = [] >>> for","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) ==","for y in ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) ==","c.evaluate([x, x, x])) >>> all(results) True \"\"\" return bits([x.not_() for x in self])","return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits, other: bits)","/ {2}) >>> [[b.value for b in bs] for bs in bss] [[1,","__ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self,","\"\"\" return bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\" >>> results = []","xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2):","bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","def __eq__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","inputs([y, y, y])) ... zs = outputs(xs | ys) ... ns = [int(z)",">>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1, 0], [1,","pylint: disable=W0123 try: # Construct the circuit and add it to the function","x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for y in","return bit.operation(op.and_, self, other) def __and__(self, other): \"\"\" >>> results = [] >>>","__matmul__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits, other: bits) ->","other)]) def __eq__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","int) else other) def or_(self, other): \"\"\" >>> results = [] >>> for","c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>>","last): ... RuntimeError: automated circuit synthesis failed \"\"\" # Functions for determining types/signature","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y)))","output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other)","input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1,","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y))","> 0: b = ~(~b) # Preserve the bit by copying it to","(x, y) in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \"\"\"",">>> 2 - input(0) Traceback (most recent call last): ... ValueError: can only","zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ... c","y])) >>> all(results) True \"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)])","def __le__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","bit.operation(op.or_, self, other) def __or__(self, other): \"\"\" >>> results = [] >>> for","x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for","bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for","y, y])) >>> all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self,","for (x, y) in [(0, 0), (0, 1), (1, 0), (1, 1)]: ...",">>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>>","output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_,","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs == ys)",">>> results = [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ...","__gt__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <=","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) ==","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other)","ys = outputs(~xs) ... ns = [int(y) for y in ys] ... c","all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self:","bit vectors.\"\"\" return self + other def constants(l): return bits(map(constant, l)) def inputs(l):","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ==","b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_,","x, x]), inputs([y, y, y])) ... zs = outputs(xs & ys) ... ns","def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return","y, y])) ... zs = outputs(xs ^ ys) ... ns = [int(z) for","\"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits, other)","is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod","= outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ... c =","zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \"\"\" >>> results =","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b)","= outputs(xs <= ys) ... ns = [int(z) for z in zs] ...","= constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\" return","designated as a variable input from one source.\"\"\" class input_two(input): \"\"\"Bit that is","zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ... c","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ...","class input(bit): \"\"\"Bit that is designated as a variable input.\"\"\" def __init__(self: bit,","# Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return","for b in bs] for bs in bss] [[1], [1, 1, 1], [0,","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b)","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns =","& xy[1]) >>> xys = [bits([x, y]) for x in (0, 1) for","y) | ((1 - x) & (1 - y)) >>> xys = [bits([x,","return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1,","... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __invert__(self):","bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 0","subtract a bit from the integer 1') def and_(self, other): \"\"\" >>> results","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xor_(y)","self, other) def if_(self, other): \"\"\" >>> results = [] >>> for (x,","type `bit` or `bits`. >>> @synthesize ... def equal(x: bit, y: bit) ->","all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self:","None: r = bit._hook_operation(o, v, *args) if r is not None: return r","input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two))","bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1","vectors.\"\"\" return self + other def constants(l): return bits(map(constant, l)) def inputs(l): return","args[1] # Compute the value of the result of the operation on the","b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_,","other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" return self + other def constants(l):","and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence","y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0,","type(b1) else: return bit \"\"\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation,","if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] #","reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\"","ys = outputs(xs.not_()) ... ns = [int(y) for y in ys] ... c","for bs in bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>>","operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1)))","in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0)))","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z)","automatically synthesizing a circuit from a function that takes only `bit` and/or `bits`","-> bits: \"\"\" Return bits object given the supplied argument. \"\"\" return bits_type(argument)\\","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xnor_(y) for","return bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\" >>> results = [] >>>","is bit else outputs # For forward-compatibility with PEP 563. eval_ = lambda","\"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits, other:","0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0] \"\"\" return","bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def nif_(self,","and/or `bits` objects as its arguments and returns an output of type `bit`","*args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook","result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\"","def __lshift__(self: bits, other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit,","self & (constant(other) if isinstance(other, int) else other) def nimp(self, other): \"\"\" >>>","zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \"\"\" >>> results =","output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \"\"\"","in xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ...","inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z","class output(bit): \"\"\" Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0","[equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>> @synthesize ... def","bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\" >>> results = [] >>> for","an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>>","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs % ys)","inputs([y, y, y])) ... zs = outputs(xs == ys) ... ns = [int(z)","list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def","b = 1 ^ constant(0) >>> b.value 1 \"\"\" return self ^ (constant(other)","gate_ def __int__(self): return self.value def not_(self): \"\"\" >>> results = [] >>>",">>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\" >>>","y, y])) >>> all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self,","x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for","... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is None else gate_","bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","arguments. v = o(*[a.value for a in args]) # Return output from hook","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns =","@synthesize ... def equal(x: bit, y: bit) -> bit: ... return (x &","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z)","... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True","(0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys]","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.or_(y) for (x, y)","[[1], [1, 1, 1], [0, 0, 0, 0]] \"\"\" if isinstance(other, list) and","return bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\" >>> results = [] >>>","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def","that is designated as a variable input from one source.\"\"\" class input_two(input): \"\"\"Bit","x, x]), inputs([y, y, y])) ... zs = outputs(xs <= ys) ... ns","== 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length","1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>>","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","assembling logic circuits. Embedded domain-specific combinator library for assembling abstract definitions of logic","all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self:","bits: \"\"\" >>> results = [] >>> for x in [0, 1]: ...","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other) def nif(self,","None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def","None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return","y, y])) ... zs = outputs(xs > ys) ... ns = [int(z) for",">>> [b.value for b in bs] [0, 0, 0, 1, 1, 1, 1,","all(results) True \"\"\" return bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\" >>> results","return bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\" >>> results = [] >>>","y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in","if a is bit else inputs([0] * a) type_out = lambda a: output","other) def nand(self, other): \"\"\" >>> results = [] >>> for (x, y)","@staticmethod def constructor(b1, b2=None): # The inference code below is not currently in","bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>>","all(results) True \"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results = []","... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","other)]) def __or__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_,","def __le__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>>","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) ==","imp_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ...","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit","1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0,","# Return the original function. return f if __name__ == \"__main__\": doctest.testmod() #","1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>","1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(xs.not_())","True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits,","to represent the wires within a circuit built up out of those operators.","for b in bs] [1, 0, 0, 0, 0, 0, 0, 0] \"\"\"","= bs >> {3} >>> [b.value for b in bs] [1, 1, 1,","Check if bit is ready as final output or whether there are others","circuit_ is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit","for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \"\"\" >>>","True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits,","else other) def nor(self, other): \"\"\" >>> results = [] >>> for (x,","(k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit()","import annotations from typing import Sequence import doctest from parts import parts from","bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value","isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two):","-> int: \"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys","> input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other) def","all(results) True \"\"\" return self.nimp(other) def nif(self, other): \"\"\" >>> results = []","bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>>","= output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __rsub__(self,","bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\" >>> results = [] >>> for","other) def nand_(self, other): \"\"\" >>> results = [] >>> for (x, y)","argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self: bits)","output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value]","= bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\" Class for representing","bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit =","x])) >>> all(results) True \"\"\" return bits([x.not_() for x in self]) def __invert__(self:","f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None # Return","inputs([x, x, x]) ... ys = outputs(~xs) ... ns = [int(y) for y","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs < ys)","def __new__(cls, argument = None) -> bits: \"\"\" Return bits object given the","return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits, other: bits)",">>> all(results) True \"\"\" return self.nif(other) def xor(self, other): \"\"\" >>> results =","def synthesize(f): \"\"\" Decorator for automatically synthesizing a circuit from a function that","bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1","bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent","int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and","other)]) def __le__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x))","bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys))","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def __lt__(self,","def __mod__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \"\"\" >>> results = [] >>>","set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity])","__future__ import annotations from typing import Sequence import doctest from parts import parts","= None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not None:","nimp_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","True \"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\" >>> results =","def nif(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>",">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2})","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","self, other) def nif_(self, other): \"\"\" >>> results = [] >>> for (x,","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\"","exists and if # it returns an output. if bit._hook_operation is not None:","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","self.gate = bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return self.value","that is designated as a variable input.\"\"\" def __init__(self: bit, value: int): self.value","\"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits, other:","/ [1, 3, 4]) >>> [[b.value for b in bs] for bs in","def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value","\"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self: bits) ->",">>> all(results) True \"\"\" return bits([x.not_() for x in self]) def __invert__(self: bits)","isinstance(a, str) else a # pylint: disable=W0123 try: # Construct the circuit and","output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_,","self, other) def nor_(self, other): \"\"\" >>> results = [] >>> for (x,","Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))","... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","try: # Construct the circuit and add it to the function as an","input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is","y) in zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \"\"\" >>>","it returns an output. if bit._hook_operation is not None: r = bit._hook_operation(o, v,","else gate_ def __int__(self): return self.value def not_(self): \"\"\" >>> results = []","bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>","inputs([y, y, y])) ... zs = outputs(xs < ys) ... ns = [int(z)","return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self:","x, x]), inputs([y, y, y])) ... zs = outputs(xs | ys) ... ns","1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in","def nimp(self, other): \"\"\" >>> results = [] >>> for (x, y) in","logic circuits and synthesizing circuits from those definitions. \"\"\" from __future__ import annotations","inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z","y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs]","= output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self,","[b0.value, b1.value, b2.value] [0, 1, 0] \"\"\" def __init__(self: bit, b: bit): #","\"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits, other:","definitions. \"\"\" from __future__ import annotations from typing import Sequence import doctest from","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","class input_one(input): \"\"\"Bit that is designated as a variable input from one source.\"\"\"","in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>>","gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate","xy[1]) >>> xys = [bits([x, y]) for x in (0, 1) for y","all(results) True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self:","output or whether there are others dependent on it. if len(b.gate.outputs) > 0:","True \"\"\" return self.nif(other) def xor(self, other): \"\"\" >>> results = [] >>>","b = ~(~b) # Preserve the bit by copying it to a new",">>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def nand(self, other): \"\"\" >>>","(1 - y)) >>> xys = [bits([x, y]) for x in (0, 1)","also used to keep track of relationships between operators and to represent the","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs %","other) def xnor(self, other): \"\"\" >>> results = [] >>> for (x, y)","[a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>>","outputs(xs == ys) ... ns = [int(z) for z in zs] ... c","type_in = lambda a: input(0) if a is bit else inputs([0] * a)","*args): # Ensure second argument is a `bit`. args = list(args) if len(args)","r = bit._hook_operation(o, v, *args) if r is not None: return r return","x in self]) def __invert__(self: bits) -> bits: \"\"\" >>> results = []","def nif_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits,","def or_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","self, other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 ^","return bit \"\"\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def","in xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) ->","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) ==","b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0,","outputs(xs | ys) ... ns = [int(z) for z in zs] ... c","y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs]","\"\"\" return bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\" >>> results = []","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other)","abstract bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_)",">>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\" >>>",">>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1,","b.value 0 \"\"\" return self & (constant(other) if isinstance(other, int) else other) def","all(results) True \"\"\" return self.nif(other) def xor(self, other): \"\"\" >>> results = []","results = [] >>> for (x, y) in [(0, 0), (0, 1), (1,","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b)","len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit by copying it","y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs]","y])) >>> all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)])","x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for","bits) -> bits: \"\"\" >>> results = [] >>> for x in [0,","not None: r = bit._hook_operation(o, v, *args) if r is not None: return","nor(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","bs >> {3} >>> [b.value for b in bs] [1, 1, 1, 0,","-> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_())","self, other) def __or__(self, other): \"\"\" >>> results = [] >>> for (x,","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) ==","zs = outputs(xs | ys) ... ns = [int(z) for z in zs]","as a variable input from a second source.\"\"\" class output(bit): \"\"\" Bit that","(x & y) | ((1 - x) & (1 - y)) >>> xys","from a function that takes only `bit` and/or `bits` objects as its arguments","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xnor_(y) for (x, y)","\"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\" >>> results = []","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ...","in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in","zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ... c","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\"","return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that is designated as a constant","for b in bs] [0, 0, 0, 1, 1, 1, 1, 0] >>>","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ==","ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument = None) ->","in zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \"\"\" >>> results","def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return None else:","output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other)","** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other)","y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in","\"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits, other:","-> bits: \"\"\" >>> results = [] >>> for x in [0, 1]:","is bit else inputs([0] * a) type_out = lambda a: output if a","result of the operation on the arguments. v = o(*[a.value for a in","isinstance(other, int) else other) def nor(self, other): \"\"\" >>> results = [] >>>","return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \"\"\" Return bits object","and to represent the wires within a circuit built up out of those","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nif_(y) for","# Functions for determining types/signature from # the type annotation of the decorated","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y))","for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b)","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns","gate_ is None else gate_ def __int__(self): return self.value def not_(self): \"\"\" >>>","\"\"\" return bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b","y) in zip(self, other)]) def imp(self: bits, other: bits) -> bits: \"\"\" >>>","outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","{3} >>> [b.value for b in bs] [1, 1, 1, 0, 0, 0,","(x, y) in zip(self, other)]) def nif(self: bits, other: bits) -> bits: \"\"\"","For forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str)","... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","a value, but it is also used to keep track of relationships between","__invert__(self: bits) -> bits: \"\"\" >>> results = [] >>> for x in","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","the decorated function. type_in = lambda a: input(0) if a is bit else","1') def and_(self, other): \"\"\" >>> results = [] >>> for (x, y)","\"\"\" Class for representing a vector of abstract bits. \"\"\" @staticmethod def from_byte(byte_:","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) |","= outputs(xs & ys) ... ns = [int(z) for z in zs] ...","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","is not currently in use. \"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one): return","if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit by copying","[0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) ==",">>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __and__(self, other): \"\"\" >>>","x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys) ... ns =","y) in zip(self, other)]) def nand_(self: bits, other) -> bits: \"\"\" >>> results","else args[1] # Compute the value of the result of the operation on","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y))","None # Return the original function. return f if __name__ == \"__main__\": doctest.testmod()","bits(list): \"\"\" Class for representing a vector of abstract bits. \"\"\" @staticmethod def","bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits, other: bits) ->","all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self:","all(results) True \"\"\" return bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit())","... zs = outputs(xs >= ys) ... ns = [int(z) for z in","output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v,","the result of the operation on the arguments. v = o(*[a.value for a","bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation","outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys))","and synthesizing circuits from those definitions. \"\"\" from __future__ import annotations from typing","y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs]","if_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","in zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \"\"\" >>> results","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns","def xor_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","import doctest from parts import parts from circuit import op, gate, circuit, signature","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\"","bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits, other: bits) ->","value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that","raise RuntimeError('automated circuit synthesis failed') from None # Return the original function. return","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def","... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs == ys) ...","outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>",">>> [b.value for b in bs] [1, 0, 0, 0, 0, 0, 0,","subtract a bit from the integer 1 \"\"\" if other == 1: return","bs = bs >> {3} >>> [b.value for b in bs] [1, 1,","eval_ = lambda a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123","True \"\"\" return bit.operation(op.and_, self, other) def __and__(self, other): \"\"\" >>> results =","y) in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ...","... zs = outputs(xs <= ys) ... ns = [int(z) for z in","__xor__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except:","designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_())","zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \"\"\" >>> results =","all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\" >>> results","constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in","bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3,","output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other)","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __xor__(self,",">>> @synthesize ... def equal(x, y): ... return x & y Traceback (most","# Return output from hook if it exists and if # it returns","bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\" >>> results = [] >>> for","y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs]","y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in zs]","... def equal(x, y): ... return x & y Traceback (most recent call","bit by copying it to a new wire. self.value = b.value self.gate =","\"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\" >>> results = []","bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>> [[b.value for","b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","y, y])) >>> all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self,","= list(bs / {2}) >>> [[b.value for b in bs] for bs in","\"\"\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\" >>> results = []","in zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \"\"\" >>> results","return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\" Decorator for","r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in",">>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\" >>>","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys))","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def","constant(0) >>> b.value 1 \"\"\" return self | (constant(other) if isinstance(other, int) else","True \"\"\" return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that is designated as","hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ...","\"\"\"Bit that is designated as a variable input.\"\"\" def __init__(self: bit, value: int):","def nor(self, other): \"\"\" >>> results = [] >>> for (x, y) in","value self.gate = bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return","all(results) True \"\"\" return bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\" >>> results","y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs]","__ge__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","y])) >>> all(results) True \"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)])","[1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0]","input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else: return",">>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call","y) in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \"\"\" >>>","def __xor__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\"","outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self)))","bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \"\"\" Return bits object given","\"\"\" return bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\" >>> results = []","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other)","= outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ... c =","list) and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) #","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ...","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nif_(y) for (x,","... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit,","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xnor_(y)","... ns = [int(y) for y in ys] ... c = bit.circuit() ...","all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self:","isinstance(other, int) else other) def or_(self, other): \"\"\" >>> results = [] >>>","bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits, other: bits) ->","else: return bit \"\"\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs)","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","ns = [int(y) for y in ys] ... c = bit.circuit() ... results.append(ns","x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for","a is bit else outputs # For forward-compatibility with PEP 563. eval_ =",">>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit","def nand(self, other): \"\"\" >>> results = [] >>> for (x, y) in","__mod__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","return bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b =","-> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1,","x, x]), inputs([y, y, y])) ... zs = outputs(xs % ys) ... ns","1, 0, 0, 0, 0, 0, 0, 0, 0] \"\"\" return bits([ bit_","@staticmethod def operation(o, *args): # Ensure second argument is a `bit`. args =","1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))","__eq__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","= output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit())","parts from circuit import op, gate, circuit, signature class bit(): \"\"\" Class for","xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y)","in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \"\"\" >>> results","bs >> 3 >>> [b.value for b in bs] [0, 0, 0, 1,","(0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>>","a `bit`. args = list(args) if len(args) == 2: args[1] = constant(args[1]) if","[b.value for b in bs] [0, 0, 0, 1, 1, 1, 1, 0]","for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b","b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_,","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y)))",">>> all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def","[1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>> [[b.value for b","`bits` objects as its arguments and returns an output of type `bit` or",">>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0,","map(bits, parts(self, other)) # Number of parts is `other`. def __add__(self: bits, other)","of lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return","y) in zip(self, other)]) def __mod__(self, other) -> bits: \"\"\" >>> results =","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys))","[[b.value for b in bs] for bs in bss] [[1, 1], [1, 1],","1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0]","inputs([0] * a) type_out = lambda a: output if a is bit else","all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit())",">>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ...","/ 2) >>> ([b.value for b in bss[0]], [b.value for b in bss[1]])","bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \"\"\" if isinstance(other, list)","an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items()","k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in))","inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z","parts is `other`. def __add__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\"","zs = outputs(xs <= ys) ... ns = [int(z) for z in zs]","b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>>",">>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\" >>>","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <",">= ys) ... ns = [int(z) for z in zs] ... c =","in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \"\"\" >>> results","logic circuits. Embedded domain-specific combinator library for assembling abstract definitions of logic circuits","... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ...","\"\"\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit,","an input or output type of a function decorated for automated synthesis. \"\"\"","self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903","isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) **","inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z","(x, y) in zip(self, other)]) def imp(self: bits, other: bits) -> bits: \"\"\"","zip(self, other)]) def xor(self: bits, other: bits) -> bits: \"\"\" >>> results =","Functions for determining types/signature from # the type annotation of the decorated function.","if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if r is","return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits, other: bits)","True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits,","b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args): ...","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ...","bits(map(output, l)) def synthesize(f): \"\"\" Decorator for automatically synthesizing a circuit from a","other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l):","b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_,","True \"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits,","nand_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","True \"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\" >>> results =",">>> xys = [bits([x, y]) for x in (0, 1) for y in","def __pow__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" return self +","__lshift__(self: bits, other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))","bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\" >>> results = [] >>> for",">>> all(results) True \"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def","def not_(self: bits) -> bits: \"\"\" >>> results = [] >>> for x","a circuit from a function that takes only `bit` and/or `bits` objects as","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs > ys)","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys))","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns =","(x, y) in zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \"\"\"","y])) ... zs = outputs(xs > ys) ... ns = [int(z) for z","bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \"\"\" return bits([x.not_()","self]) def and_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else: return bit","... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ...","k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis","[[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ...","bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for b in","^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self,",">>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\" >>>","\"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits, other:","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def __ge__(self, other):","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","inference code below is not currently in use. \"\"\" if isinstance(b1, input_one) and","isinstance(other, int) else other) def nimp(self, other): \"\"\" >>> results = [] >>>","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns","... zs = outputs(xs == ys) ... ns = [int(z) for z in","is None else gate_ def __int__(self): return self.value def not_(self): \"\"\" >>> results","| ((1 - x) & (1 - y)) >>> xys = [bits([x, y])","x in self]) def and_(self: bits, other: bits) -> bits: \"\"\" >>> results","0, 0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def","output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2","y) in zip(self, other)]) def nor(self: bits, other: bits) -> bits: \"\"\" >>>","if other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit","True \"\"\" return bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\" >>> results =","xor_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None #","xy in xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize",">>> [[b.value for b in bs] for bs in bss] [[1], [1, 1,","_circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not",">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2)","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ...","in zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \"\"\" >>> results","return x & y Traceback (most recent call last): ... RuntimeError: automated circuit","`bit` and/or `bits` objects as its arguments and returns an output of type","[(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b =",">>> all(results) True \"\"\" return bits([x.not_() for x in self]) def and_(self: bits,","... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>>","[0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for b in bs]","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) ==","(x, y) in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit())","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ...","y])) >>> all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)])","it to the function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a))","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ...","outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","synthesis failed \"\"\" # Functions for determining types/signature from # the type annotation",">>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^","bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits, other: bits) ->","bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits, other) -> bits:","l)) def synthesize(f): \"\"\" Decorator for automatically synthesizing a circuit from a function","isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else: return bit \"\"\"","def __int__(self): return self.value def not_(self): \"\"\" >>> results = [] >>> for","[1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for b in bs]","0, 0, 0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)])","[y.value for y in ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls,","... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ...","b = 0 & constant(1) >>> b.value 0 \"\"\" return self & (constant(other)","library for assembling abstract definitions of logic circuits and synthesizing circuits from those","[[b.value for b in bs] for bs in bss] [[1], [1, 1, 1],","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other)","... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","def not_(self): \"\"\" >>> results = [] >>> for x in [0, 1]:","xnor(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits,","rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs","bit.operation(op.imp_, self, other) def nand(self, other): \"\"\" >>> results = [] >>> for","\"\"\"Concatenation of bit vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits,","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs & ys)","True \"\"\" return bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\" >>> results =","bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def","inputs([y, y, y])) ... zs = outputs(xs > ys) ... ns = [int(z)","... zs = outputs(xs < ys) ... ns = [int(z) for z in","imp(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","a variable input from a second source.\"\"\" class output(bit): \"\"\" Bit that is","\"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits, other:","bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits, other: bits)","* a) type_out = lambda a: output if a is bit else outputs","function decorated for automated synthesis. \"\"\" class bits(list): \"\"\" Class for representing a","circuit import op, gate, circuit, signature class bit(): \"\"\" Class for representing an","b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_,","(len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self, other)) # Number","a constant input.\"\"\" class input(bit): \"\"\"Bit that is designated as a variable input.\"\"\"","for xy in xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy:","def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is","bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits, other: bits) ->","== bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args): ... return","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y))","= outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ... c =","for representing an input or output type of a function decorated for automated","bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","up out of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit())","for (x, y) in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits:","-> bits: \"\"\"Concatenation of bit vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result) def","output if a is bit else outputs # For forward-compatibility with PEP 563.","in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0])","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def","y])) >>> all(results) True \"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)])",">>> all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def","in bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>>","inputs([y, y, y])) ... zs = outputs(xs <= ys) ... ns = [int(z)","bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" return self + other def","to the function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for","bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs","other)]) def __lt__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits,","True \"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits,","__xor__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","- x) & (1 - y)) >>> xys = [bits([x, y]) for x","0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit,",">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y))","for (x, y) in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits:","x in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy","self, other) def imp_(self, other): \"\"\" >>> results = [] >>> for (x,","else outputs # For forward-compatibility with PEP 563. eval_ = lambda a: eval(a)","y, y])) ... zs = outputs(xs < ys) ... ns = [int(z) for","from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for","2) >>> ([b.value for b in bss[0]], [b.value for b in bss[1]]) ([1,","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __and__(self, other): \"\"\"","inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z","all(results) True \"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self:","b in bs] [1, 0, 0, 0, 0, 0, 0, 0] \"\"\" return","for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit)","[b.value for b in bs] [1, 1, 1, 0, 0, 0, 0, 1]","a circuit built up out of those operators. >>> bit.hook_operation(lambda o, v, *args:","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b)","__init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is None","if gate_ is None else gate_ def __int__(self): return self.value def not_(self): \"\"\"","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>> results = [] >>> for x","bs in bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit())",">>> all(results) True \"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nimp_(y) for (x,","True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits,","reversed(self))) def not_(self: bits) -> bits: \"\"\" >>> results = [] >>> for","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xor_(y) for (x, y)","bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1 \"\"\" return self","b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit())","0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs /","= outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ... c =","x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for","concretely as a value, but it is also used to keep track of","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns =","x]), inputs([y, y, y])) ... zs = outputs(xs < ys) ... ns =","Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \"\"\" >>>",">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value","... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for x","represent the wires within a circuit built up out of those operators. >>>","bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def imp(self, other):","bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits, other) -> bits:","a: output if a is bit else outputs # For forward-compatibility with PEP","Parts of length `other`. else: return map(bits, parts(self, other)) # Number of parts","return bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\" >>> results = [] >>>","constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1,","isinstance(args[1], int) else args[1] # Compute the value of the result of the","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b)","[0, 0, 0, 0]] \"\"\" if isinstance(other, list) and len(other) > 0 and","other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ...","bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits, other: bits) ->","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nif_(y)","for y in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x,","returns an output of type `bit` or `bits`. >>> @synthesize ... def equal(x:","1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","imp(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ...","inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z","bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits, other: bits) ->","y) in zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \"\"\" >>>","as a variable input from one source.\"\"\" class input_two(input): \"\"\"Bit that is designated","... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0],","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nand_(y)","y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in zs]","... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ...","lambda a: input(0) if a is bit else inputs([0] * a) type_out =","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns","... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","(x, y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \"\"\" Overloaded","== bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most","return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits, other: bits)","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nor_(y) for (x,","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b)","list(bs / {2}) >>> [[b.value for b in bs] for bs in bss]","other)]) def __gt__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","all(results) True \"\"\" return bits([x.not_() for x in self]) def __invert__(self: bits) ->","int) else\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>>","... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","\"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits, other:","other)]) def __ge__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","= output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","bit) -> bit: ... return (x & y) | ((1 - x) &","inputs([y, y, y])) ... zs = outputs(xs ^ ys) ... ns = [int(z)","results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \"\"\" return bits([x.not_() for x","circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable()",">>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def imp(self, other): \"\"\" >>>","y) in zip(self, other)]) def xor(self: bits, other: bits) -> bits: \"\"\" >>>","in zip(self, other)]) def __mod__(self, other) -> bits: \"\"\" >>> results = []","all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self:","def __lt__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in","\"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits, other:","self.nif(other) def xor(self, other): \"\"\" >>> results = [] >>> for (x, y)","a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int):","recent call last): ... RuntimeError: automated circuit synthesis failed \"\"\" # Functions for","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <","0, 0, 0, 0, 0, 0, 0] \"\"\" return bits([ bit_ for byte_","x, x])) >>> all(results) True \"\"\" return bits([x.not_() for x in self]) def","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ...","sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \"\"\"","& (1 - y)) >>> xys = [bits([x, y]) for x in (0,","# Sequence of lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0],","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b)","... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ...","= list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \"\"\"Concatenation of","0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self:","output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_,","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __or__(self, other):","by copying it to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_,","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) =","y, y])) ... zs = outputs(xs | ys) ... ns = [int(z) for","^ ys) ... ns = [int(z) for z in zs] ... c =","b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\" Class","other) def nor_(self, other): \"\"\" >>> results = [] >>> for (x, y)","wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint:","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns =","return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits, other: bits)","1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0])","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) ==","... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other) -> bits:","(most recent call last): ... RuntimeError: automated circuit synthesis failed \"\"\" # Functions","hook @staticmethod def operation(o, *args): # Ensure second argument is a `bit`. args","self, other) def nand_(self, other): \"\"\" >>> results = [] >>> for (x,","... zs = outputs(xs ^ ys) ... ns = [int(z) for z in","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","__pow__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" return self + other","return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results = [] >>> for x","is designated as a variable input from a second source.\"\"\" class output(bit): \"\"\"","\"\"\" return self | (constant(other) if isinstance(other, int) else other) def nor(self, other):","-> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y])","o(*[a.value for a in args]) # Return output from hook if it exists","return bit.operation(op.if_, self, other) def imp(self, other): \"\"\" >>> results = [] >>>","i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit())","= list(bs / 2) >>> ([b.value for b in bss[0]], [b.value for b","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ...","y) in zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \"\"\" >>>",">>> all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def","True \"\"\" return bit.operation(op.imp_, self, other) def nand(self, other): \"\"\" >>> results =","bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ^","self, other) def __ge__(self, other): \"\"\" >>> results = [] >>> for (x,","in bs] for bs in bss] [[1, 1], [1, 1], [0, 0], [0,","# Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \"\"\"","zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \"\"\" >>> results =","inputs([y, y, y])) ... zs = outputs(xs >= ys) ... ns = [int(z)","if isinstance(other, int) else other) def nor(self, other): \"\"\" >>> results = []","operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >>","int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self:","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y)))","of the decorated function. type_in = lambda a: input(0) if a is bit","... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","\"\"\" return bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\" >>> results = []","and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two","bits: \"\"\" >>> results = [] >>> for (x, y) in [(0, 0),",">>> all(results) True \"\"\" return self.nimp(other) def nif(self, other): \"\"\" >>> results =","y) in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \"\"\" >>>","0, 0]] \"\"\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int):","in self]) def __invert__(self: bits) -> bits: \"\"\" >>> results = [] >>>","disable=R0903 \"\"\" Class for representing an input or output type of a function","Construct the circuit and add it to the function as an attribute. bit.circuit(circuit())","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs | ys) ...","designated as a constant input.\"\"\" class input(bit): \"\"\"Bit that is designated as a","= output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self,","in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) ->","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","import parts from circuit import op, gate, circuit, signature class bit(): \"\"\" Class","bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\" >>> results = [] >>> for","b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"",">>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\" >>>","for (x, y) in zip(self, other)]) def __and__(self: bits, other: bits) -> bits:","None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit","isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set)","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def nand(self, other): \"\"\"","outputs # For forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if","y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in","disable=W0123 try: # Construct the circuit and add it to the function as","for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit())","from hook if it exists and if # it returns an output. if","True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last): ...","as its arguments and returns an output of type `bit` or `bits`. >>>","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\"","... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other)","| input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self,","b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_,","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other) def xor(self, other): \"\"\" >>> results","inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z","bs = bs << 3 >>> [b.value for b in bs] [1, 0,","circuit, signature class bit(): \"\"\" Class for representing an abstract bit. Such a","b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_,","all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self:","zs = outputs(xs % ys) ... ns = [int(z) for z in zs]","def __or__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","int) else other) def nor(self, other): \"\"\" >>> results = [] >>> for","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","def imp_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","source.\"\"\" class output(bit): \"\"\" Bit that is designated an output. >>> bit.circuit(circuit()) >>>","bs] [1, 0, 0, 0, 0, 0, 0, 0] \"\"\" return bits(self[other:]) **","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other)","return bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\" >>> results = [] >>>","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns =","= list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other])","bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z)","inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns =","def xnor(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","= bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is designated as a variable input","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y))","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs > ys) ...","args = list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int)","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def nor_(self, other):","1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys))","x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z)","b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","__lt__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for","\"\"\" Class for representing an input or output type of a function decorated","annotation of the decorated function. type_in = lambda a: input(0) if a is","or whether there are others dependent on it. if len(b.gate.outputs) > 0: b","all(results) True \"\"\" return bit.operation(op.xor_, self, other) def xor_(self, other): \"\"\" >>> results","bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for","return bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b =","bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second argument is a","\"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits, other:","def nimp_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","0: b = ~(~b) # Preserve the bit by copying it to a","1 ^ constant(0) >>> b.value 1 \"\"\" return self ^ (constant(other) if isinstance(other,","bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\"","self, other) def nand(self, other): \"\"\" >>> results = [] >>> for (x,",">>> bs = bs >> {3} >>> [b.value for b in bs] [1,","output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_,","ready as final output or whether there are others dependent on it. if","as a value, but it is also used to keep track of relationships","argument = None) -> bits: \"\"\" Return bits object given the supplied argument.","self + other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l))","(x, y) in zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \"\"\"","of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b","for (x, y) in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits:","0]] \"\"\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return","all(results) True \"\"\" return bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\" >>> results","all(results) True \"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\" >>> results","0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x, y):","else: return map(bits, parts(self, other)) # Number of parts is `other`. def __add__(self:","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b)","args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k !=","y) in zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \"\"\" >>>","y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in","-> bits: \"\"\"Concatenation of bit vectors.\"\"\" return self + other def constants(l): return","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ...","== c.evaluate([x, x, x])) >>> all(results) True \"\"\" return bits([x.not_() for x in","zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys","\"\"\" # Functions for determining types/signature from # the type annotation of the","from typing import Sequence import doctest from parts import parts from circuit import","& y Traceback (most recent call last): ... RuntimeError: automated circuit synthesis failed","== ys) ... ns = [int(z) for z in zs] ... c =","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif","... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","= output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self,","bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \"\"\"",">>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True","0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs /","or `bits`. >>> @synthesize ... def equal(x: bit, y: bit) -> bit: ...","outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\"","y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in zs]","all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self:","([b.value for b in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1,","bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\" >>> results = [] >>> for","1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","currently in use. \"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @","def xnor_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits,","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) ==","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b)","bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that is designated as a constant input.\"\"\"","output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other)","__mod__(self, other) -> bits: \"\"\" >>> results = [] >>> for (x, y)","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b)","... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","designated as a variable input.\"\"\" def __init__(self: bit, value: int): self.value = value","1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length `other`.","circuits and synthesizing circuits from those definitions. \"\"\" from __future__ import annotations from","def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args]))","bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>>","[bits([x, y]) for x in (0, 1) for y in (0, 1)] >>>","@staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value =",">>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\" >>>","self.value def not_(self): \"\"\" >>> results = [] >>> for x in [0,","x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) ==","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __and__(self,","dependent on it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the","1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs =","y])) ... zs = outputs(xs & ys) ... ns = [int(z) for z","with PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str) else a","`bit`. args = list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1],","bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits, other: bits) ->","\"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\" >>> results = []","... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ...","len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of","results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return","nor_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))]","y])) ... zs = outputs(xs | ys) ... ns = [int(z) for z","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) ==","length `other`. else: return map(bits, parts(self, other)) # Number of parts is `other`.","x]), inputs([y, y, y])) ... zs = outputs(xs | ys) ... ns =","= lambda a: input(0) if a is bit else inputs([0] * a) type_out",">>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 =","... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \"\"\" return bits([x.not_() for",">>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation = None @staticmethod","nimp(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","y, y])) ... zs = outputs(xs & ys) ... ns = [int(z) for","outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\" Decorator for automatically synthesizing a circuit","other) def nif_(self, other): \"\"\" >>> results = [] >>> for (x, y)","True \"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\" >>> results =","`other`. def __add__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" result =","y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in","True \"\"\" return bits([x.not_() for x in self]) def __invert__(self: bits) -> bits:","xs = inputs([x, x, x]) ... ys = outputs(~xs) ... ns = [int(y)","Class for representing a vector of abstract bits. \"\"\" @staticmethod def from_byte(byte_: int,","for (x, y) in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits:","x]), inputs([y, y, y])) ... zs = outputs(xs & ys) ... ns =","isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: #","2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value","all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\" >>> results","gate, circuit, signature class bit(): \"\"\" Class for representing an abstract bit. Such","isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2","return self.value def not_(self): \"\"\" >>> results = [] >>> for x in","self | (constant(other) if isinstance(other, int) else other) def nor(self, other): \"\"\" >>>","`bits`. >>> @synthesize ... def equal(x: bit, y: bit) -> bit: ... return","all(results) True \"\"\" return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>> results =","... ys = outputs(xs.not_()) ... ns = [int(y) for y in ys] ...","for a in args]) # Return output from hook if it exists and","\"\"\" return bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\" >>> results = []","all(results) True \"\"\" return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that is designated","self, other) class constant(bit): \"\"\"Bit that is designated as a constant input.\"\"\" class","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ...","constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i)","Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs","bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\" Class for representing an","return bits([x.not_() for x in self]) def and_(self: bits, other: bits) -> bits:","= output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self,","all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self:","((1 - x) & (1 - y)) >>> xys = [bits([x, y]) for","(x, y) in zip(self, other)]) def __mod__(self, other) -> bits: \"\"\" >>> results","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y))","1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","# Parts of length `other`. else: return map(bits, parts(self, other)) # Number of","or_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","__init__(self: bit, b: bit): # Check if bit is ready as final output","zip(self, other)]) def nand_(self: bits, other) -> bits: \"\"\" >>> results = []","bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results)","is also used to keep track of relationships between operators and to represent","... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \"\"\" def __init__(self: bit, b:","\"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits, other:","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) ==","class bits(list): \"\"\" Class for representing a vector of abstract bits. \"\"\" @staticmethod","... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","input.\"\"\" class input(bit): \"\"\"Bit that is designated as a variable input.\"\"\" def __init__(self:","True \"\"\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\" >>> results =","\"\"\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return map(bits,","variable input from one source.\"\"\" class input_two(input): \"\"\"Bit that is designated as a","r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None):","from circuit import op, gate, circuit, signature class bit(): \"\"\" Class for representing","True \"\"\" return bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\" >>> results =","bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_):","= ~(~b) # Preserve the bit by copying it to a new wire.","= output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self,","x]), inputs([y, y, y])) ... zs = outputs(xs == ys) ... ns =","True \"\"\" return bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>>","outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \"\"\" def __init__(self:","0] \"\"\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits,","__le__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","in bs] [1, 0, 0, 0, 0, 0, 0, 0] \"\"\" return bits(self[other:])","in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \"\"\" >>> results","def nor_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","as a constant input.\"\"\" class input(bit): \"\"\"Bit that is designated as a variable","bs = bs >> 3 >>> [b.value for b in bs] [0, 0,","outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","raise ValueError('can only subtract a bit from the integer 1') def and_(self, other):","bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\" >>> results = [] >>> for","= [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs =","= bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None # Return the","\"\"\" return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that is designated as a","def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\"","args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value of","outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","return bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\" >>> results = [] >>>","b2.value] [0, 1, 0] \"\"\" def __init__(self: bit, b: bit): # Check if","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ...","for (x, y) in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits:","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other) def nif(self, other): \"\"\"","Traceback (most recent call last): ... RuntimeError: automated circuit synthesis failed \"\"\" #","all(results) True \"\"\" return bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit())","def nand(self: bits, other) -> bits: \"\"\" >>> results = [] >>> for","zs = outputs(xs == ys) ... ns = [int(z) for z in zs]","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b)","def imp(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","if a is bit else outputs # For forward-compatibility with PEP 563. eval_","other): \"\"\" >>> results = [] >>> for (x, y) in [(0, 0),","if isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \"\"\" >>>","def if_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","= outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ... c =","argument is a `bit`. args = list(args) if len(args) == 2: args[1] =","self, other) def __xor__(self, other): \"\"\" >>> results = [] >>> for (x,",">>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) class constant(bit): \"\"\"Bit that is","in zip(self, other)]) def nif(self: bits, other: bits) -> bits: \"\"\" >>> results","for (x, y) in zip(self, other)]) def imp(self: bits, other: bits) -> bits:","isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0])","= inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for","(x, y) in zip(self, other)]) def nor(self: bits, other: bits) -> bits: \"\"\"","< ys) ... ns = [int(z) for z in zs] ... c =","all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last):","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b)","ns = [int(z) for z in zs] ... c = bit.circuit() ... results.append(ns","0, 0] \"\"\" return bits([ bit_ for byte_ in bytes_ for bit_ in","zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ... c","(x, y) in zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \"\"\"","563. eval_ = lambda a: eval(a) if isinstance(a, str) else a # pylint:","self, other) def __gt__(self, other): \"\"\" >>> results = [] >>> for (x,","= 1 | constant(0) >>> b.value 1 \"\"\" return self | (constant(other) if","in zip(self, other)]) def nand_(self: bits, other) -> bits: \"\"\" >>> results =","variable input.\"\"\" def __init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_,","_hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit =","x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for y in ys]","self.nimp(other) def nif(self, other): \"\"\" >>> results = [] >>> for (x, y)","for x in self]) def __invert__(self: bits) -> bits: \"\"\" >>> results =","= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for b","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other) def nif(self, other):",">>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1 \"\"\" return","length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other) == 1 and","bits, other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>","as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in","int) else args[1] # Compute the value of the result of the operation","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ...","\"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits, other:","def equal(x: bit, y: bit) -> bit: ... return (x & y) |","return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other)","the arguments. v = o(*[a.value for a in args]) # Return output from","<= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self,","/ (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self, other)) #","y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs]","__invert__(self): \"\"\" >>> results = [] >>> for x in [0, 1]: ...","nand(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,",">>> b = 1 | constant(0) >>> b.value 1 \"\"\" return self |","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.or_(y) for (x,","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x,","bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ...","= output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","y in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x]))","y: bit) -> bit: ... return (x & y) | ((1 - x)","xor(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","= bs << 3 >>> [b.value for b in bs] [1, 0, 0,","... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ...","__rshift__(self: bits, other) -> bits: \"\"\" Overloaded operator: rotation and shift operations. >>>","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.or_(y) for","return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): #","True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits,","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs | ys)","zip(self, other)]) def imp(self: bits, other: bits) -> bits: \"\"\" >>> results =","of length `other`. else: return map(bits, parts(self, other)) # Number of parts is","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other) def xor(self, other): \"\"\" >>>","for (x, y) in zip(self, other)]) def nand_(self: bits, other) -> bits: \"\"\"","synthesis. \"\"\" class bits(list): \"\"\" Class for representing a vector of abstract bits.","in zip(self, other)]) def if_(self: bits, other: bits) -> bits: \"\"\" >>> results","import op, gate, circuit, signature class bit(): \"\"\" Class for representing an abstract","\"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits, other:","shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs","return bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b =","a vector of abstract bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits:","Such a bit can be interpreted concretely as a value, but it is","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys))","other)]) def __mod__(self, other) -> bits: \"\"\" >>> results = [] >>> for","def nand_(self: bits, other) -> bits: \"\"\" >>> results = [] >>> for","return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits, other: bits)",">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y)))","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","results = [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs","operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>","def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for b in","imp_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0])","y, y])) >>> all(results) True \"\"\" return bits([x.if_(y) for (x, y) in zip(self,","class input_two(input): \"\"\"Bit that is designated as a variable input from a second","= b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\"","-> bit: ... return (x & y) | ((1 - x) & (1","= bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return self.value def","zip(self, other)]) def if_(self: bits, other: bits) -> bits: \"\"\" >>> results =","a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b =","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","of a function decorated for automated synthesis. \"\"\" class bits(list): \"\"\" Class for","0, 0, 0, 0, 1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0], int): #",">>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\" >>>","bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results = [] >>> for x in","set) and len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) #","x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z)","= o(*[a.value for a in args]) # Return output from hook if it","... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","b.value 1 \"\"\" return self ^ (constant(other) if isinstance(other, int) else other) def","bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return self.value def not_(self):","v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return","bit(): \"\"\" Class for representing an abstract bit. Such a bit can be","nimp(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","... RuntimeError: automated circuit synthesis failed \"\"\" # Functions for determining types/signature from","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) ==","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ...","else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o,","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y))","variable input from a second source.\"\"\" class output(bit): \"\"\" Bit that is designated","b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_,","([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs =","= None) -> bits: \"\"\" Return bits object given the supplied argument. \"\"\"","xnor_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def imp_(self, other):","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) ==","for (k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit =","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","y, y, y])) >>> all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in","0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >>","x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ...","return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one,","there are others dependent on it. if len(b.gate.outputs) > 0: b = ~(~b)","= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for b","all(results) True \"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self:","@staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return None","1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results)","bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\" >>> results = [] >>> for","__rsub__(self, other): \"\"\" >>> results = [] >>> for x in [0, 1]:","second source.\"\"\" class output(bit): \"\"\" Bit that is designated an output. >>> bit.circuit(circuit())","[0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0],","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y)))","only subtract a bit from the integer 1 \"\"\" if other == 1:","return bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\" >>> results = [] >>>","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def nif_(self, other):","def or_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits,","x]), inputs([y, y, y])) ... zs = outputs(xs > ys) ... ns =","Class for representing an abstract bit. Such a bit can be interpreted concretely","0, 0, 0] \"\"\" return bits([ bit_ for byte_ in bytes_ for bit_","y) in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \"\"\" >>>","equal(x, y): ... return x & y Traceback (most recent call last): ...","y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in zs]","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def __lt__(self, other):","\"\"\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value,","return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit))","return bit.operation(op.nimp_, self, other) def nimp_(self, other): \"\"\" >>> results = [] >>>","% ys) ... ns = [int(z) for z in zs] ... c =","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs |","# Check if bit is ready as final output or whether there are","given the supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument)","b.value 1 \"\"\" return self | (constant(other) if isinstance(other, int) else other) def","... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\"","o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value ==","def __add__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" result = list(self)","zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \"\"\" >>> results =","return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits, other) ->","ValueError: can only subtract a bit from the integer 1 \"\"\" if other","forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str) else","x, x]) ... ys = outputs(~xs) ... ns = [int(y) for y in","range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value","return bits([x.not_() for x in self]) def __invert__(self: bits) -> bits: \"\"\" >>>","\"\"\" return bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor)","bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) ->","list(bs / 2) >>> ([b.value for b in bss[0]], [b.value for b in","0, 0, 0, 0] \"\"\" return bits([ bit_ for byte_ in bytes_ for","inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z","only subtract a bit from the integer 1') def and_(self, other): \"\"\" >>>","{2}) >>> [[b.value for b in bs] for bs in bss] [[1, 1],","\"\"\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1 \"\"\"","zip(self, other)]) def nand(self: bits, other) -> bits: \"\"\" >>> results = []","a bit can be interpreted concretely as a value, but it is also","\"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits, other)","def xor_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","circuit built up out of those operators. >>> bit.hook_operation(lambda o, v, *args: None)","self, other) def xnor_(self, other): \"\"\" >>> results = [] >>> for (x,","all(results) True \"\"\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\" >>> results","bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z","for (x, y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \"\"\"","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self, other):","int) else other) def nimp(self, other): \"\"\" >>> results = [] >>> for","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns","- y)) >>> xys = [bits([x, y]) for x in (0, 1) for","... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","self, other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 |","b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_,","b1.value, b2.value] [0, 1, 0] \"\"\" def __init__(self: bit, b: bit): # Check","... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","b in bs] for bs in bss] [[1], [1, 1, 1], [0, 0,","return (x & y) | ((1 - x) & (1 - y)) >>>","wires within a circuit built up out of those operators. >>> bit.hook_operation(lambda o,","0 \"\"\" return self & (constant(other) if isinstance(other, int) else other) def nimp(self,","__and__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for",">>> [y.value for y in ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n) def","[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1","below is not currently in use. \"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one):",">>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __or__(self, other): \"\"\" >>>","outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","\"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results = [] >>> for","for x in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for","all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self:","in zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \"\"\" >>> results","[0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>>","= outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ... c =","function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a)","= output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","output type of a function decorated for automated synthesis. \"\"\" class bits(list): \"\"\"",">>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\" >>>","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.if_(y) for (x,","= outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ... c =","def __xor__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for b","@synthesize ... def equal(x, y): ... return x & y Traceback (most recent","bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(~xs) ... ns","= outputs(xs < ys) ... ns = [int(z) for z in zs] ...","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys))","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __rand__(self,","= output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self)","outputs(xs.not_()) ... ns = [int(y) for y in ys] ... c = bit.circuit()","True \"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\" >>> results =","= lambda a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try:","def nimp_(self, other): \"\"\" >>> results = [] >>> for (x, y) in","y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \"\"\" Overloaded operator:","(x, y) in zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \"\"\"","operation(o, *args): # Ensure second argument is a `bit`. args = list(args) if","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y))","\"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits, other)",">>> bs = bs << 3 >>> [b.value for b in bs] [1,","in bs] [1, 1, 1, 0, 0, 0, 0, 1] \"\"\" if isinstance(other,","= bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for b","y) in zip(self, other)]) def or_(self: bits, other: bits) -> bits: \"\"\" >>>","y])) ... zs = outputs(xs ^ ys) ... ns = [int(z) for z","def __int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0,","... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","in zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \"\"\" >>> results","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\"","- input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2","def outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\" Decorator for automatically synthesizing a","if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit","x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z)","bit else outputs # For forward-compatibility with PEP 563. eval_ = lambda a:","... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other)","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ...","return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None): #","equal(x: bit, y: bit) -> bit: ... return (x & y) | ((1","bit else inputs([0] * a) type_out = lambda a: output if a is",">>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>> @synthesize ...","outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \"\"\" >>> results","1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ...","True \"\"\" return self.nimp(other) def nif(self, other): \"\"\" >>> results = [] >>>","if isinstance(a, str) else a # pylint: disable=W0123 try: # Construct the circuit","circuit synthesis failed') from None # Return the original function. return f if","True \"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>>",">>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>>","bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","= outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ... c =","self, other) def __mod__(self, other): \"\"\" >>> results = [] >>> for (x,","a function decorated for automated synthesis. \"\"\" class bits(list): \"\"\" Class for representing","add it to the function as an attribute. bit.circuit(circuit()) args_in = { k:","nor_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\" >>> results","constant(0) >>> b.value 1 \"\"\" return self ^ (constant(other) if isinstance(other, int) else","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self, other):","return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits, other: bits)","output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other)","def imp(self, other): \"\"\" >>> results = [] >>> for (x, y) in","is None: return type(b1) else: return bit \"\"\" return bit @staticmethod def gate(operation,","y) in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \"\"\" >>>","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ...","return bits(result) def __pow__(self: bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" return","if bit is ready as final output or whether there are others dependent","in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits:","in ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument = None)","zs = outputs(xs > ys) ... ns = [int(z) for z in zs]","... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ...","(x, y) in zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \"\"\"","zip(self, other)]) def nor(self: bits, other: bits) -> bits: \"\"\" >>> results =","None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None):",">>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 -","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >","[0, 1, 0] \"\"\" def __init__(self: bit, b: bit): # Check if bit","in bs] [0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>>","nand(self: bits, other) -> bits: \"\"\" >>> results = [] >>> for (x,","... zs = outputs(xs % ys) ... ns = [int(z) for z in","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs % ys) ...","\"\"\" return bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\" >>> results = []","zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ... c","... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","# Construct the circuit and add it to the function as an attribute.","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys))","of bit vectors.\"\"\" return self + other def constants(l): return bits(map(constant, l)) def","output of type `bit` or `bits`. >>> @synthesize ... def equal(x: bit, y:","supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self:","not_(self: bits) -> bits: \"\"\" >>> results = [] >>> for x in","in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \"\"\" >>> results","bits, other) -> bits: \"\"\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit())","\"\"\" Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_())","for representing an abstract bit. Such a bit can be interpreted concretely as","& constant(1) >>> b.value 0 \"\"\" return self & (constant(other) if isinstance(other, int)","bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for (x,","bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for b in","not currently in use. \"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one","out of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>>","bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1,","value, but it is also used to keep track of relationships between operators","def nif(self, other): \"\"\" >>> results = [] >>> for (x, y) in","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns","1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits, other: bits) ->","self, other) def __lt__(self, other): \"\"\" >>> results = [] >>> for (x,","= outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ... c =","x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for","other)]) def or_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","None: return type(b1) else: return bit \"\"\" return bit @staticmethod def gate(operation, igs):","y, y])) >>> all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self,","bss = list(bs / {2}) >>> [[b.value for b in bs] for bs","an output of type `bit` or `bits`. >>> @synthesize ... def equal(x: bit,","integer 1 \"\"\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can only","inputs([y, y, y])) ... zs = outputs(xs % ys) ... ns = [int(z)","all(results) True \"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self:","# Compute the value of the result of the operation on the arguments.","operation on the arguments. v = o(*[a.value for a in args]) # Return","return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits, other: bits)","doctest from parts import parts from circuit import op, gate, circuit, signature class","x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b)","y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in",">>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1 \"\"\" return","[] >>> for (x, y) in [(0, 0), (0, 1), (1, 0), (1,","\"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs /","bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","from __future__ import annotations from typing import Sequence import doctest from parts import","\"\"\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a","output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other)","is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\" Class for representing an input or","arguments and returns an output of type `bit` or `bits`. >>> @synthesize ...","zs = outputs(xs ^ ys) ... ns = [int(z) for z in zs]","zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \"\"\" >>> results =","... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","for b in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1],",">> {3} >>> [b.value for b in bs] [1, 1, 1, 0, 0,","[1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for","other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","return bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\" >>> results = [] >>>","= outputs(xs > ys) ... ns = [int(z) for z in zs] ...","for bs in bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \"\"\"","b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation","bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def nand(self, other):","c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \"\"\"","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns","\"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and","bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k","return type(b1) else: return bit \"\"\" return bit @staticmethod def gate(operation, igs): return","except: raise RuntimeError('automated circuit synthesis failed') from None # Return the original function.","[1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))","(x, y) in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \"\"\"","self) def __rsub__(self, other): \"\"\" >>> results = [] >>> for x in","^ (constant(other) if isinstance(other, int) else other) def or_(self, other): \"\"\" >>> results","y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in zs]","... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","def __init__(self: bit, b: bit): # Check if bit is ready as final","inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z","zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ... c",">>> b = 1 ^ constant(0) >>> b.value 1 \"\"\" return self ^","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b)","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other)","other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs",">>> bss = list(bs / {2}) >>> [[b.value for b in bs] for","bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results","other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1)","bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","integer 1') def and_(self, other): \"\"\" >>> results = [] >>> for (x,","def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2","y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0],","... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","and if # it returns an output. if bit._hook_operation is not None: r","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ...","0, 0, 0, 0, 0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0) for _","`bit` or `bits`. >>> @synthesize ... def equal(x: bit, y: bit) -> bit:",">>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) ==","= output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self,","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ...","True >>> def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o,","is designated as a constant input.\"\"\" class input(bit): \"\"\"Bit that is designated as","self, other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 0 &","bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None): # The inference","y])) ... zs = outputs(xs % ys) ... ns = [int(z) for z","in zip(self, other)]) def nand(self: bits, other) -> bits: \"\"\" >>> results =","v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0]","inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for y","is designated as a variable input.\"\"\" def __init__(self: bit, value: int): self.value =","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __or__(self, other): \"\"\"","operators and to represent the wires within a circuit built up out of","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\"","x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for","for (x, y) in zip(self, other)]) def xor_(self: bits, other: bits) -> bits:","of bit vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other)","a # pylint: disable=W0123 try: # Construct the circuit and add it to","zip(self, other)]) def or_(self: bits, other: bits) -> bits: \"\"\" >>> results =","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) %","b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_,","& y) | ((1 - x) & (1 - y)) >>> xys =","b in bs] for bs in bss] [[1, 1], [1, 1], [0, 0],","x]), inputs([y, y, y])) ... zs = outputs(xs <= ys) ... ns =","output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other)","a variable input.\"\"\" def __init__(self: bit, value: int): self.value = value self.gate =","new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): #","a bit from the integer 1 \"\"\" if other == 1: return bit.operation(op.not_,","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b)","of the result of the operation on the arguments. v = o(*[a.value for","types/signature from # the type annotation of the decorated function. type_in = lambda","Return the original function. return f if __name__ == \"__main__\": doctest.testmod() # pragma:","the integer 1') def and_(self, other): \"\"\" >>> results = [] >>> for","... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0)","zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ... c","... return (x & y) | ((1 - x) & (1 - y))","[conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1, 0], [1, 1]]",">>> b.value 0 \"\"\" return self & (constant(other) if isinstance(other, int) else other)","(x, y) in zip(self, other)]) def or_(self: bits, other: bits) -> bits: \"\"\"","bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits, other: bits) ->","bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x,","return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value ==",">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1,","... ys = outputs(~xs) ... ns = [int(y) for y in ys] ...","second argument is a `bit`. args = list(args) if len(args) == 2: args[1]","0] \"\"\" def __init__(self: bit, b: bit): # Check if bit is ready","bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits, other: bits) ->",">>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0,","an abstract bit. Such a bit can be interpreted concretely as a value,","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def xor_(self,","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __and__(self, other):","a second source.\"\"\" class output(bit): \"\"\" Bit that is designated an output. >>>","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ...",">>> b.value 1 \"\"\" return self | (constant(other) if isinstance(other, int) else other)","... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","xy[0] & xy[1]) >>> xys = [bits([x, y]) for x in (0, 1)","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>",">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3","xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ... def","other) def __matmul__(self, other): \"\"\" >>> results = [] >>> for (x, y)","all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\" >>> results","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ...","failed \"\"\" # Functions for determining types/signature from # the type annotation of","parts import parts from circuit import op, gate, circuit, signature class bit(): \"\"\"","bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \"\"\" >>> results =","return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits, other) ->","other)]) def __rshift__(self: bits, other) -> bits: \"\"\" Overloaded operator: rotation and shift","outputs(~xs) ... ns = [int(y) for y in ys] ... c = bit.circuit()","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) ==","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.if_(y)","all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self:","bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results) True","bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for b in","\"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other) ->","1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","== bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\"","nand_(self: bits, other) -> bits: \"\"\" >>> results = [] >>> for (x,","(constant(other) if isinstance(other, int) else other) def nor(self, other): \"\"\" >>> results =","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for","1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1],","in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>>","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def","= outputs(xs | ys) ... ns = [int(z) for z in zs] ...",">>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def imp_(self, other): \"\"\" >>>","for xy in xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>>","return bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\" >>> results = [] >>>","True \"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits,","(x, y) in zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \"\"\"","b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \"\"\" >>> results =","return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate()","0, 0, 1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity","1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","\"\"\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\" >>> results = []","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y)))","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y) for","*args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ...","bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def","def __matmul__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","self) def __invert__(self): \"\"\" >>> results = [] >>> for x in [0,","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y)))","in zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \"\"\" >>> results","b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_,","recent call last): ... ValueError: can only subtract a bit from the integer","z in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x,","\"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\" >>> results = []","def operation(o, *args): # Ensure second argument is a `bit`. args = list(args)","@ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self,","xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\"","True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits,","bits: \"\"\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs =","can only subtract a bit from the integer 1 \"\"\" if other ==","return bit.operation(op.imp_, self, other) def nand(self, other): \"\"\" >>> results = [] >>>","y) in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \"\"\" >>>","bits_type(int): # pylint: disable=R0903 \"\"\" Class for representing an input or output type","= outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ... c =","else a # pylint: disable=W0123 try: # Construct the circuit and add it","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) ==","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.and_(y)","int): return self / (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits,","b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","for (x, y) in zip(self, other)]) def xor(self: bits, other: bits) -> bits:","y])) ... zs = outputs(xs <= ys) ... ns = [int(z) for z","def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>>","int: \"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys =","bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if r is not","from one source.\"\"\" class input_two(input): \"\"\"Bit that is designated as a variable input","and returns an output of type `bit` or `bits`. >>> @synthesize ... def","7 \"\"\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits)",">>> ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i, b)","\"\"\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys)","all(results) True \"\"\" return bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\" >>> results","bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\" Decorator for automatically","Compute the value of the result of the operation on the arguments. v","zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ... c","def __invert__(self: bits) -> bits: \"\"\" >>> results = [] >>> for x","b in bs] [1, 1, 1, 0, 0, 0, 0, 1] \"\"\" if","track of relationships between operators and to represent the wires within a circuit","\"\"\" from __future__ import annotations from typing import Sequence import doctest from parts","bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for","vector of abstract bits. \"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return","zip(self, other)]) def __rshift__(self: bits, other) -> bits: \"\"\" Overloaded operator: rotation and","input_two(input): \"\"\"Bit that is designated as a variable input from a second source.\"\"\"","all(results) True \"\"\" return bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\" >>> results","(x, y) in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \"\"\"","[0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss","... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","is designated as a variable input from one source.\"\"\" class input_two(input): \"\"\"Bit that","1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results)","... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","__int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0])","bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0 \"\"\" return self","return bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\" >>> results = [] >>>","list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \"\"\"Concatenation of bit","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns =","y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in","-> bits: \"\"\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs","if r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a","output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other)","in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0, 0,","\"\"\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0 \"\"\"","the supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument) def","the circuit and add it to the function as an attribute. bit.circuit(circuit()) args_in","l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \"\"\" Decorator for automatically synthesizing","y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in","[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x,","and len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts","0] \"\"\" return bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_,","decorated function. type_in = lambda a: input(0) if a is bit else inputs([0]","of type `bit` or `bits`. >>> @synthesize ... def equal(x: bit, y: bit)","it to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True)","hook if it exists and if # it returns an output. if bit._hook_operation","= inputs([x, x, x]) ... ys = outputs(~xs) ... ns = [int(y) for","bit): # Check if bit is ready as final output or whether there","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) ==","-> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)])","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def","return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self: bits) -> int:","output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other)","bits, other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" result = list(self) result.extend(list(other)) return","[b.value for b in bs] [1, 0, 0, 0, 0, 0, 0, 0]","[1, 0], [1, 1]] >>> @synthesize ... def equal(x, y): ... return x","use. \"\"\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two)","other)]) def if_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","input(0) if a is bit else inputs([0] * a) type_out = lambda a:","... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ...","== bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None):","in args]) # Return output from hook if it exists and if #","original function. return f if __name__ == \"__main__\": doctest.testmod() # pragma: no cover","x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z)","... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit by","= outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ... c =","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","other)]) def __and__(self: bits, other: bits) -> bits: \"\"\" >>> results = []","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ...","and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs =","y) in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \"\"\" >>>","= outputs(xs % ys) ... ns = [int(z) for z in zs] ...","class bits_type(int): # pylint: disable=R0903 \"\"\" Class for representing an input or output","bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self, other)","all(results) True \"\"\" return bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\" >>> results","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z)","for (x, y) in zip(self, other)]) def __or__(self: bits, other: bits) -> bits:","constant(bit): \"\"\"Bit that is designated as a constant input.\"\"\" class input(bit): \"\"\"Bit that","bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None): # The","self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \"\"\"Bit that is designated as a variable","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >","y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in","\"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits, other:","output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_,","those definitions. \"\"\" from __future__ import annotations from typing import Sequence import doctest","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns","circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other) def nimp_(self, other):","... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>>","output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation = None","if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2,","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","\"\"\" class bits(list): \"\"\" Class for representing a vector of abstract bits. \"\"\"","\"\"\"Bit that is designated as a constant input.\"\"\" class input(bit): \"\"\"Bit that is","[0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss","... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","\"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits, other:","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y)))","that is designated as a variable input from a second source.\"\"\" class output(bit):","\"\"\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \"\"\" Return bits","zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ... c","y, y])) >>> all(results) True \"\"\" return bits([x.and_(y) for (x, y) in zip(self,","__or__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","list(bs / [1, 3, 4]) >>> [[b.value for b in bs] for bs","... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return",">>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\" >>>","def constructor(b1, b2=None): # The inference code below is not currently in use.","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b)","x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z)","True \"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits,","1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0,","from the integer 1') def and_(self, other): \"\"\" >>> results = [] >>>","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other) def xor(self,","bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last): ... ValueError: can","nif(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits, other: bits)","_ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>>","def __gt__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","y, y])) >>> all(results) True \"\"\" return bits([x.or_(y) for (x, y) in zip(self,","bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>>","zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \"\"\" >>> results =",">>> for (x, y) in [(0, 0), (0, 1), (1, 0), (1, 1)]:","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x,","def xnor_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>",">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value","def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit,","circuit synthesis failed \"\"\" # Functions for determining types/signature from # the type","[b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \"\"\" Class for representing an input","len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of",">>> [b0.value, b1.value, b2.value] [0, 1, 0] \"\"\" def __init__(self: bit, b: bit):","\"\"\" return self ^ (constant(other) if isinstance(other, int) else other) def or_(self, other):","\"\"\" return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>> results = [] >>>","= output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self,","\"\"\" >>> results = [] >>> for x in [0, 1]: ... bit.circuit(circuit())","1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(~xs)","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nor_(y)","y) in zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \"\"\" >>>","all(results) True \"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self:","y, y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in","x]), inputs([y, y, y])) ... zs = outputs(xs >= ys) ... ns =","bit, b: bit): # Check if bit is ready as final output or","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def nor_(self,","== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.or_(y)","... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True","return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits, other: bits)","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns =","def xnor(self, other): \"\"\" >>> results = [] >>> for (x, y) in","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ...","in zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \"\"\" >>> results","bit from the integer 1') def and_(self, other): \"\"\" >>> results = []","if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self,","if_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for",">>> bss = list(bs / 2) >>> ([b.value for b in bss[0]], [b.value","0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x, y): ... return","abstract bit. Such a bit can be interpreted concretely as a value, but","= output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \"\"\" def __init__(self: bit,","constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_,","in zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \"\"\" >>> results","other) def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0)","True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits,","bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>>","... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ...","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns =","__int__(self): return self.value def not_(self): \"\"\" >>> results = [] >>> for x","b = 1 | constant(0) >>> b.value 1 \"\"\" return self | (constant(other)",">>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\" >>>","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def __ge__(self, other): \"\"\"","bit can be interpreted concretely as a value, but it is also used","bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs =","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __ror__(self,","None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ...","def __rsub__(self, other): \"\"\" >>> results = [] >>> for x in [0,","= output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self,","is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 =","other) class constant(bit): \"\"\"Bit that is designated as a constant input.\"\"\" class input(bit):","y in ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument =","y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in","from the integer 1 \"\"\" if other == 1: return bit.operation(op.not_, self) raise","\"\"\" return bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def if_(self,","y, y, y])) >>> all(results) True \"\"\" return bits([x.if_(y) for (x, y) in","outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) ==","return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else:","xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in ys]","y, y, y])) >>> all(results) True \"\"\" return bits([x.or_(y) for (x, y) in","ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i, b) in","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ...","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b)","= output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_, self,","return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod","return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>> results = [] >>> for","return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __ror__(self, other): \"\"\"","... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","other: bits) -> bits: \"\"\" >>> results = [] >>> for (x, y)","@staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in","return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits, other: bits)","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns","eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try: # Construct the","x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for","isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other))","bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\" >>> results = [] >>> for","0, 0, 0, 0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0) for _ in","in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \"\"\" >>> results","__truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))","<< 3 >>> [b.value for b in bs] [1, 0, 0, 0, 0,","lambda a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try: #","3 >>> [b.value for b in bs] [1, 0, 0, 0, 0, 0,","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y))","from # the type annotation of the decorated function. type_in = lambda a:","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x)","y, y, y])) >>> all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\"","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\"","in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \"\"\" >>> results","else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits:","... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ...","\"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits, other:","y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in","b in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1], [0,","bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns",">>> bss = list(bs / [1, 3, 4]) >>> [[b.value for b in","other) def __or__(self, other): \"\"\" >>> results = [] >>> for (x, y)","def __ror__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>>","\"\"\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_","... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ...","return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for x in","input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return",">>> b.value 1 \"\"\" return self ^ (constant(other) if isinstance(other, int) else other)","\"\"\" return bit.operation(op.nor_, self, other) def xnor(self, other): \"\"\" >>> results = []","[0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return","if isinstance(other, int) else other) def or_(self, other): \"\"\" >>> results = []","(x, y) in zip(self, other)]) def nand_(self: bits, other) -> bits: \"\"\" >>>","hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second argument is","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nimp_(y) for (x, y)","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs & ys) ...","__le__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","x, x]), inputs([y, y, y])) ... zs = outputs(xs == ys) ... ns","it exists and if # it returns an output. if bit._hook_operation is not","can be interpreted concretely as a value, but it is also used to","= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for b","isinstance(argument, int) else\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit())","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nor_(y) for","assembling abstract definitions of logic circuits and synthesizing circuits from those definitions. \"\"\"","not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def __mod__(self, other):","return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) ->","self.value = value self.gate = bit._circuit.gate() if gate_ is None else gate_ def","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def __ge__(self,","lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return self","of parts is `other`. def __add__(self: bits, other) -> bits: \"\"\"Concatenation of bit","conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys =","bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for","other) def xor_(self, other): \"\"\" >>> results = [] >>> for (x, y)","input(bit): \"\"\"Bit that is designated as a variable input.\"\"\" def __init__(self: bit, value:","1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0,","`other`. else: return map(bits, parts(self, other)) # Number of parts is `other`. def","bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>>","nif(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","self, other) def __and__(self, other): \"\"\" >>> results = [] >>> for (x,","all(results) True \"\"\" return bits([x.not_() for x in self]) def and_(self: bits, other:","is not None: r = bit._hook_operation(o, v, *args) if r is not None:","zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \"\"\" >>> results =","self / (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self, other))","True \"\"\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \"\"\" >>> results =","for assembling abstract definitions of logic circuits and synthesizing circuits from those definitions.","input from a second source.\"\"\" class output(bit): \"\"\" Bit that is designated an","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >= ys)","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \"\"\"","bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"",">>> all(results) True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def","= bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in ys] [1,","y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs]","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def xor_(self, other):","bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\" >>> results = [] >>> for","... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ...","[(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys)","bit.operation(op.if_, self, other) def imp(self, other): \"\"\" >>> results = [] >>> for","its arguments and returns an output of type `bit` or `bits`. >>> @synthesize","zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \"\"\" >>> results =","__lt__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","else other) def or_(self, other): \"\"\" >>> results = [] >>> for (x,","zs = outputs(xs & ys) ... ns = [int(z) for z in zs]","the integer 1 \"\"\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self, other):",">>> bs = bs >> 3 >>> [b.value for b in bs] [0,","other) def __le__(self, other): \"\"\" >>> results = [] >>> for (x, y)","... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","but it is also used to keep track of relationships between operators and","bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for b in","other) def if_(self, other): \"\"\" >>> results = [] >>> for (x, y)","True \"\"\" return bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\" >>> results =","= value self.gate = bit._circuit.gate() if gate_ is None else gate_ def __int__(self):","int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys =","b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1,","def __lt__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0]","bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the integer 1') def","... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self:","for (x, y) in zip(self, other)]) def nor(self: bits, other: bits) -> bits:","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","= [bits([x, y]) for x in (0, 1) for y in (0, 1)]","b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","final output or whether there are others dependent on it. if len(b.gate.outputs) >","in self]) def and_(self: bits, other: bits) -> bits: \"\"\" >>> results =","bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ])",">>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ...","y) in zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \"\"\" >>>","= outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ... c =","\"\"\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is","nif_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","[0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>>","output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_,","nif_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def __rand__(self, other):","y])) >>> all(results) True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)])","True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits,","in zip(self, other)]) def nor(self: bits, other: bits) -> bits: \"\"\" >>> results","def __invert__(self): \"\"\" >>> results = [] >>> for x in [0, 1]:","True \"\"\" return bit.operation(op.or_, self, other) def __or__(self, other): \"\"\" >>> results =","True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other)","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","circuits. Embedded domain-specific combinator library for assembling abstract definitions of logic circuits and","in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \"\"\" >>> results = []","return bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\" >>> results = [] >>>",">>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7","b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value,","1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))]","output from hook if it exists and if # it returns an output.","... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True","class constant(bit): \"\"\"Bit that is designated as a constant input.\"\"\" class input(bit): \"\"\"Bit","y) in zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \"\"\" >>>","__or__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","< input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other) def","other)]) def imp_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits, other: bits) ->",">>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value","\"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \"\"\" >>> results = []","0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1]))","outputs(xs & ys) ... ns = [int(z) for z in zs] ... c","def zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>>","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns","output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other)","True \"\"\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_","in bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \"\"\" if isinstance(other,","b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nif_,","all(results) True \"\"\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self:","1]] >>> @synthesize ... def equal(x, y): ... return x & y Traceback","synthesizing a circuit from a function that takes only `bit` and/or `bits` objects","RuntimeError('automated circuit synthesis failed') from None # Return the original function. return f","The inference code below is not currently in use. \"\"\" if isinstance(b1, input_one)","= circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation =","or output type of a function decorated for automated synthesis. \"\"\" class bits(list):","for (x, y) in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits:","all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self:","bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>>","[1, 1, 1] \"\"\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits:","1 \"\"\" return self ^ (constant(other) if isinstance(other, int) else other) def or_(self,","... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ...","def equal(x, y): ... return x & y Traceback (most recent call last):","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def","zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y,","= outputs(~xs) ... ns = [int(y) for y in ys] ... c =","bits: \"\"\"Concatenation of bit vectors.\"\"\" return self + other def constants(l): return bits(map(constant,","zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ... c","[1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for b in bs]",">>> all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def","__rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) ==","for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b)","& ys) ... ns = [int(z) for z in zs] ... c =","bit.operation(op.nand_, self, other) def nand_(self, other): \"\"\" >>> results = [] >>> for","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <=","\"\"\" return bit.operation(op.nor_, self, other) def nor_(self, other): \"\"\" >>> results = []","and add it to the function as an attribute. bit.circuit(circuit()) args_in = {","... zs = outputs(xs & ys) ... ns = [int(z) for z in","y): ... return x & y Traceback (most recent call last): ... RuntimeError:","whether there are others dependent on it. if len(b.gate.outputs) > 0: b =","and_(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None # Return the original","y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in","bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1,","[1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for b in bs]","l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f):","(x, y) in zip(self, other)]) def if_(self: bits, other: bits) -> bits: \"\"\"","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b)","all(results) True \"\"\" return bit.operation(op.or_, self, other) def __or__(self, other): \"\"\" >>> results","bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits, other: bits)",">>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0,","y) in zip(self, other)]) def nif(self: bits, other: bits) -> bits: \"\"\" >>>","= output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self,","(x, y) in zip(self, other)]) def xor(self: bits, other: bits) -> bits: \"\"\"","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b)",">>> @synthesize ... def equal(x: bit, y: bit) -> bit: ... return (x","call last): ... ValueError: can only subtract a bit from the integer 1","x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nif_(y) for (x, y)","return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \"\"\" >>> bit.circuit(circuit())","x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z)","return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits, other: bits)","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other) def xor(self, other): \"\"\"","other)]) def nif_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","function that takes only `bit` and/or `bits` objects as its arguments and returns","= output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self,","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xor_(y) for","bits, other) -> bits: \"\"\" >>> results = [] >>> for (x, y)","y, y])) ... zs = outputs(xs <= ys) ... ns = [int(z) for","input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other)","x]), inputs([y, y, y])) ... zs = outputs(xs % ys) ... ns =","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self, other) def","output. if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if r","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ...","for (x, y) in zip(self, other)]) def nor_(self: bits, other: bits) -> bits:","(1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y,","typing import Sequence import doctest from parts import parts from circuit import op,","x in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy","hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0]","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b)","return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None):","@staticmethod def zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3)","... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","[int(z) for z in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x,","is ready as final output or whether there are others dependent on it.","return bit.operation(op.or_, self, other) def __or__(self, other): \"\"\" >>> results = [] >>>","y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in","= [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b =","== bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>>",">> 3 >>> [b.value for b in bs] [0, 0, 0, 1, 1,","= output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self,","... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y]))","= outputs(xs == ys) ... ns = [int(z) for z in zs] ...","= list(bs / [1, 3, 4]) >>> [[b.value for b in bs] for","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) ==","\"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value","bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits, other: bits) ->","bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\"","Return bits object given the supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int)","if isinstance(other, int) else other) def nimp(self, other): \"\"\" >>> results = []","import Sequence import doctest from parts import parts from circuit import op, gate,","\"\"\" return bits([x.not_() for x in self]) def __invert__(self: bits) -> bits: \"\"\"","= 1 ^ constant(0) >>> b.value 1 \"\"\" return self ^ (constant(other) if","other)]) def xor(self: bits, other: bits) -> bits: \"\"\" >>> results = []","0 & constant(1) >>> b.value 0 \"\"\" return self & (constant(other) if isinstance(other,","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def if_(self, other):","bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \"\"\" >>>","return bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\" >>> results = [] >>>","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z)","other)]) def nand(self: bits, other) -> bits: \"\"\" >>> results = [] >>>","\"\"\" >>> results = [] >>> for (x, y) in [(0, 0), (0,","return self | (constant(other) if isinstance(other, int) else other) def nor(self, other): \"\"\"","xor_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def __mod__(self,","1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0] \"\"\"","failed') from None # Return the original function. return f if __name__ ==","@staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> [b.value for b","!= 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed')","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self, other):","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.and_(y) for (x,","1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","bit.circuit().evaluate([0,0])[0] True \"\"\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if","outputs(xs < ys) ... ns = [int(z) for z in zs] ... c","return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits, other: bits)","constructor(b1, b2=None): # The inference code below is not currently in use. \"\"\"","[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_())","return self.nif(other) def xor(self, other): \"\"\" >>> results = [] >>> for (x,","Number of parts is `other`. def __add__(self: bits, other) -> bits: \"\"\"Concatenation of","-> bits: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs =","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","= [int(z) for z in zs] ... c = bit.circuit() ... results.append(ns ==","def __ge__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns","... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True","True \"\"\" return bit.operation(op.not_, self) def __rsub__(self, other): \"\"\" >>> results = []","bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits,","\"\"\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1,","[0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys =","other) -> bits: \"\"\"Concatenation of bit vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result)","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y)))","other) -> bits: \"\"\" >>> results = [] >>> for (x, y) in","bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]:","other): \"\"\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) ==","bit \"\"\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self,","True \"\"\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits,",">>> all(results) True \"\"\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \"\"\" >>>",">>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ...","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b)","\"\"\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other)","= output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o,","[b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1]","in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>>","= outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ... c =","ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results)","for (x, y) in zip(self, other)]) def nimp(self: bits, other: bits) -> bits:","elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return self /","is_input=True) class input_one(input): \"\"\"Bit that is designated as a variable input from one","y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in zs]","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.nand_(y) for (x,","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) ==","Ensure second argument is a `bit`. args = list(args) if len(args) == 2:","bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y)))","len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute","other) -> bits: \"\"\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>>",">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3","and b2 is None: return type(b1) else: return bit \"\"\" return bit @staticmethod","def nor(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","\"\"\" return bit.operation(op.and_, self, other) def __and__(self, other): \"\"\" >>> results = []","^ constant(0) >>> b.value 1 \"\"\" return self ^ (constant(other) if isinstance(other, int)",">>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\" >>>","1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b)","~(~b) # Preserve the bit by copying it to a new wire. self.value","inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z","(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ...","def __gt__(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","+ other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z)","... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs =","def xor(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs =","in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys","1, 1], [0, 0, 0, 0]] \"\"\" if isinstance(other, list) and len(other) >","... xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns =","]) @staticmethod def zeros(n: int) -> bits: \"\"\" >>> bit.circuit(circuit()) >>> xs =","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) class constant(bit):","0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0,","value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is None else","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b)",">>> all(results) True \"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\" >>> results =","\"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits, other:","[[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs =","def nimp(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>>","# Ensure second argument is a `bit`. args = list(args) if len(args) ==","= outputs(xs.not_()) ... ns = [int(y) for y in ys] ... c =","y, y])) >>> all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in zip(self,","# pylint: disable=W0123 try: # Construct the circuit and add it to the","# The inference code below is not currently in use. \"\"\" if isinstance(b1,","outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1] \"\"\" return bits([constant(0)]*n)","within a circuit built up out of those operators. >>> bit.hook_operation(lambda o, v,","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) ==","list.__new__(cls, argument) def __int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>> xs =","bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for","that is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1","= output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","bit_.gate(o, [a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit())","'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from","bits object given the supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\","bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits, other: bits) ->","[1, 1]] >>> @synthesize ... def equal(x, y): ... return x & y","Traceback (most recent call last): ... ValueError: can only subtract a bit from","bit vectors.\"\"\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) ->","\"\"\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) ->","all(results) True \"\"\" return bit.operation(op.imp_, self, other) def nand(self, other): \"\"\" >>> results","<= ys) ... ns = [int(z) for z in zs] ... c =","None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>>","= 0 & constant(1) >>> b.value 0 \"\"\" return self & (constant(other) if","other)]) def nif(self: bits, other: bits) -> bits: \"\"\" >>> results = []","__ge__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","= [] >>> for (x, y) in [(0, 0), (0, 1), (1, 0),","1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","\"\"\" return bit.operation(op.if_, self, other) def imp(self, other): \"\"\" >>> results = []","return self & (constant(other) if isinstance(other, int) else other) def nimp(self, other): \"\"\"","True \"\"\" return bit.operation(op.nif_, self, other) def nif_(self, other): \"\"\" >>> results =","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y)))","0, 0, 0, 1] \"\"\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation.","decorated for automated synthesis. \"\"\" class bits(list): \"\"\" Class for representing a vector","(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) ==","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def imp_(self,","1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b)","output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nimp_, self, other)","\"\"\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1 \"\"\"","Class for representing an input or output type of a function decorated for","self]) def __invert__(self: bits) -> bits: \"\"\" >>> results = [] >>> for","other)]) def nor(self: bits, other: bits) -> bits: \"\"\" >>> results = []","b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_,","def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>>",">= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self,","for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \"\"\"","zs = outputs(xs >= ys) ... ns = [int(z) for z in zs]","y) in zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \"\"\" >>>",">>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args):","y])) >>> all(results) True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)])","byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int)","return bits(map(output, l)) def synthesize(f): \"\"\" Decorator for automatically synthesizing a circuit from","of the operation on the arguments. v = o(*[a.value for a in args])","results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def __invert__(self): \"\"\"","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xor_, self, other) def __xor__(self, other):","b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_,","if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:])","| (constant(other) if isinstance(other, int) else other) def nor(self, other): \"\"\" >>> results","source.\"\"\" class input_two(input): \"\"\"Bit that is designated as a variable input from a","y, y, y])) >>> all(results) True \"\"\" return bits([x.nimp_(y) for (x, y) in","1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs","and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other,","1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>","True \"\"\" return bit.operation(op.and_, self, other) def __rand__(self, other): \"\"\" >>> bit.circuit(circuit()) >>>","between operators and to represent the wires within a circuit built up out","... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return","in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]]","x & y Traceback (most recent call last): ... RuntimeError: automated circuit synthesis","[1, 1, 1, 0, 0, 0, 0, 1] \"\"\" if isinstance(other, set) and","args]) # Return output from hook if it exists and if # it","all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def if_(self, other): \"\"\" >>> results","bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs","1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y]))","return self + other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input,","bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1 \"\"\" return self","object given the supplied argument. \"\"\" return bits_type(argument)\\ if isinstance(argument, int) else\\ list.__new__(cls,","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y)))","= outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ... c =","other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0)","= bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \"\"\" return","if circuit_ is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return","output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other)",">>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\" >>>","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nor_, self, other) def xnor(self,","\"\"\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \"\"\" >>> results = []","zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \"\"\" >>> results =","1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","y) in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \"\"\" >>>","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ...","... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ...","and_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","def xor(self, other): \"\"\" >>> results = [] >>> for (x, y) in","\"\"\"Bit that is designated as a variable input from one source.\"\"\" class input_two(input):","those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b =","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nif(other) def xor(self, other):","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.if_(y) for","= output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.and_, self,","xnor_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","other) def or_(self, other): \"\"\" >>> results = [] >>> for (x, y)","parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other) == 1","... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value","the function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k,","= outputs(xs >= ys) ... ns = [int(z) for z in zs] ...","... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ...","b2 is None: return type(b1) else: return bit \"\"\" return bit @staticmethod def","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.xnor_(y) for (x,","__eq__(self, other): \"\"\" >>> results = [] >>> for (x, y) in [(0,","y])) ... zs = outputs(xs >= ys) ... ns = [int(z) for z","return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits, other: bits)","3 >>> [b.value for b in bs] [0, 0, 0, 1, 1, 1,","self, other) def xor_(self, other): \"\"\" >>> results = [] >>> for (x,","x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs","representing an input or output type of a function decorated for automated synthesis.","[0, 0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x, y): ...","output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def","(x, y) in zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \"\"\"","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.imp_, self, other) def nand(self,","x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y) for (x,","result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \"\"\"Concatenation","for automatically synthesizing a circuit from a function that takes only `bit` and/or","... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.if_, self, other) def","for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0],","True \"\"\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits,",">>> all(results) True \"\"\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.or_, self, other) def __or__(self,","(x, y) in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \"\"\"",">>> b = 0 & constant(1) >>> b.value 0 \"\"\" return self &","bits: \"\"\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>>","elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and","[int(y) for y in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x,","bs] [1, 1, 1, 0, 0, 0, 0, 1] \"\"\" if isinstance(other, set)","bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys)","x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z)","None) -> bits: \"\"\" Return bits object given the supplied argument. \"\"\" return","... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True","bs] [0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs","return self.nimp(other) def nif(self, other): \"\"\" >>> results = [] >>> for (x,","(x, y) in zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \"\"\"","x, x]), inputs([y, y, y])) ... zs = outputs(xs > ys) ... ns","input(0) Traceback (most recent call last): ... ValueError: can only subtract a bit","b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \"\"\" return bit.operation(op.not_, self) def","[b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1,","zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \"\"\" >>> results =","0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss =","value of the result of the operation on the arguments. v = o(*[a.value","y])) >>> all(results) True \"\"\" return bits([x.imp_(y) for (x, y) in zip(self, other)])","return bit.operation(op.nand_, self, other) def __matmul__(self, other): \"\"\" >>> results = [] >>>","all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self:","isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length `other`. else: return","inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z","constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output,","a) type_out = lambda a: output if a is bit else outputs #","return bit.operation(op.imp_, self, other) def __le__(self, other): \"\"\" >>> results = [] >>>","y])) >>> all(results) True \"\"\" return bits([x.nif_(y) for (x, y) in zip(self, other)])","or_(self: bits, other: bits) -> bits: \"\"\" >>> results = [] >>> for","outputs(xs % ys) ... ns = [int(z) for z in zs] ... c","bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\"","\"\"\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \"\"\" >>> bit.circuit(circuit()) >>> b","1 \"\"\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract","argument) def __int__(self: bits) -> int: \"\"\" >>> bit.circuit(circuit()) >>> xs = constants([0,","= outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ... c =","(constant(other) if isinstance(other, int) else other) def nimp(self, other): \"\"\" >>> results =","for x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x])","(x, y) in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \"\"\"","def __mod__(self, other) -> bits: \"\"\" >>> results = [] >>> for (x,","def __rshift__(self: bits, other) -> bits: \"\"\" Overloaded operator: rotation and shift operations.","[1, 0, 0, 0, 0, 0, 0, 0] \"\"\" return bits(self[other:]) ** bits([constant(0)","ys = outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1] \"\"\"","for (x, y) in zip(self, other)]) def if_(self: bits, other: bits) -> bits:","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y)))","of relationships between operators and to represent the wires within a circuit built","0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])","== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return self.nimp(other) def nif(self, other): \"\"\" >>>","other) -> Sequence[bits]: \"\"\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss","other)]) def xor_(self: bits, other: bits) -> bits: \"\"\" >>> results = []","= output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","... ValueError: can only subtract a bit from the integer 1 \"\"\" if","0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y)))","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def xnor_(self,","the operation on the arguments. v = o(*[a.value for a in args]) #","(x, y) in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \"\"\"","[0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs","it is also used to keep track of relationships between operators and to","(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","= outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ... c =","y, y])) ... zs = outputs(xs >= ys) ... ns = [int(z) for","True \"\"\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits,","in bs] for bs in bss] [[1], [1, 1, 1], [0, 0, 0,","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys))","0, 0, 0]] \"\"\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0],","type of a function decorated for automated synthesis. \"\"\" class bits(list): \"\"\" Class","return bit.operation(op.xnor_, self, other) def __eq__(self, other): \"\"\" >>> results = [] >>>","other)]) def nimp(self: bits, other: bits) -> bits: \"\"\" >>> results = []","(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys))","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.xnor_, self, other) def __eq__(self,","a in args])) @staticmethod def constructor(b1, b2=None): # The inference code below is","c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.and_(y) for","0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif","... def equal(x: bit, y: bit) -> bit: ... return (x & y)","bs << 3 >>> [b.value for b in bs] [1, 0, 0, 0,","for (x, y) in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits:","takes only `bit` and/or `bits` objects as its arguments and returns an output","other) def nor(self, other): \"\"\" >>> results = [] >>> for (x, y)","return self ^ (constant(other) if isinstance(other, int) else other) def or_(self, other): \"\"\"","all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self:","y, y, y])) >>> all(results) True \"\"\" return bits([x.nor_(y) for (x, y) in","... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return","ValueError('can only subtract a bit from the integer 1') def and_(self, other): \"\"\"","... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>","in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>>","in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y,","output(bit): \"\"\" Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0 =","all(results) True \"\"\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self:","y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in zs]","1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>>","other) def __ge__(self, other): \"\"\" >>> results = [] >>> for (x, y)","[0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0,","return self / (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self,","a: input(0) if a is bit else inputs([0] * a) type_out = lambda","bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for","\"\"\" return bits([x.not_() for x in self]) def and_(self: bits, other: bits) ->",">>> ([b.value for b in bss[0]], [b.value for b in bss[1]]) ([1, 1,","results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \"\"\" return bit.operation(op.nand_, self, other) def __matmul__(self,","ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ...","# the type annotation of the decorated function. type_in = lambda a: input(0)","... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(~xs) ...","inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z","bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits, other: bits) ->","0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \"\"\" return sum(int(b)*(2**i) for (i,","(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns =","1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)","(i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \"\"\" >>> results","1, 1, 0, 0, 0, 0, 0, 0, 0, 0] \"\"\" return bits([","def __and__(self, other): \"\"\" >>> results = [] >>> for (x, y) in","for x in self]) def and_(self: bits, other: bits) -> bits: \"\"\" >>>","objects as its arguments and returns an output of type `bit` or `bits`.","from None # Return the original function. return f if __name__ == \"__main__\":","0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0,","is a `bit`. args = list(args) if len(args) == 2: args[1] = constant(args[1])","1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1, 0],","0], [1, 1]] >>> @synthesize ... def equal(x, y): ... return x &"],"string":"[\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b)\",\n \"other)]) def nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y)\",\n \"of logic circuits and synthesizing circuits from those definitions. \\\"\\\"\\\" from __future__ import\",\n \"bits(result) def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self, other):\",\n \"in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise\",\n \"nor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits, other: bits)\",\n \"bit from the integer 1 \\\"\\\"\\\" if other == 1: return bit.operation(op.not_, self)\",\n \"0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss =\",\n \"Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>>\",\n \"zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\" >>> results\",\n \"... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\" >>> results\",\n \"output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other)\",\n \"in zip(self, other)]) def xor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"for b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>>\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other)\",\n \"y Traceback (most recent call last): ... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\"\",\n \"in zip(self, other)]) def or_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) ==\",\n \"signature class bit(): \\\"\\\"\\\" Class for representing an abstract bit. Such a bit\",\n \"for (x, y) in zip(self, other)]) def xnor(self: bits, other: bits) -> bits:\",\n \"\\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits, other:\",\n \">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4])\",\n \"a variable input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated as\",\n \"bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs\",\n \"the original function. return f if __name__ == \\\"__main__\\\": doctest.testmod() # pragma: no\",\n \"keep track of relationships between operators and to represent the wires within a\",\n \"pylint: disable=R0903 \\\"\\\"\\\" Class for representing an input or output type of a\",\n \"self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated\",\n \"inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z\",\n \"# it returns an output. if bit._hook_operation is not None: r = bit._hook_operation(o,\",\n \"bits: \\\"\\\"\\\" Return bits object given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if\",\n \"** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\"\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >=\",\n \"\\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\" >>> results = []\",\n \">>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>>\",\n \"return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits, other: bits)\",\n \"1], [0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list) and len(other) > 0\",\n \"bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"is `other`. def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result\",\n \"= output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value,\",\n \"other)]) def __xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([\",\n \"bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns\",\n \"Return output from hook if it exists and if # it returns an\",\n \"y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs]\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for\",\n \"outputs(xs > ys) ... ns = [int(z) for z in zs] ... c\",\n \"-> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss =\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z)\",\n \"in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b)\",\n \"is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args]))\",\n \"= outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)),\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y,\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that\",\n \"the bit by copying it to a new wire. self.value = b.value self.gate\",\n \"bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0,\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\"\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\" >>> results\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\" >>>\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"circuits from those definitions. \\\"\\\"\\\" from __future__ import annotations from typing import Sequence\",\n \"True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\" >>> results =\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"as final output or whether there are others dependent on it. if len(b.gate.outputs)\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for\",\n \"outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"= lambda a: output if a is bit else outputs # For forward-compatibility\",\n \"be interpreted concretely as a value, but it is also used to keep\",\n \"> ys) ... ns = [int(z) for z in zs] ... c =\",\n \"output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>>\",\n \"bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"representing a vector of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) ->\",\n \"annotations from typing import Sequence import doctest from parts import parts from circuit\",\n \"zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"= { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return'\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y)))\",\n \"other) def __xor__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"(x, y) in zip(self, other)]) def nand(self: bits, other) -> bits: \\\"\\\"\\\" >>>\",\n \"igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate =\",\n \"1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the integer\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self,\",\n \"outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"other)) # Number of parts is `other`. def __add__(self: bits, other) -> bits:\",\n \"... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"designated as a variable input from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit\",\n \"type_out = lambda a: output if a is bit else outputs # For\",\n \"(input_one, input_two)) and b2 is None: return type(b1) else: return bit \\\"\\\"\\\" return\",\n \"self ^ (constant(other) if isinstance(other, int) else other) def or_(self, other): \\\"\\\"\\\" >>>\",\n \"for b in bs] [1, 1, 1, 0, 0, 0, 0, 1] \\\"\\\"\\\"\",\n \"= output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation =\",\n \"y) in zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self,\",\n \"inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z\",\n \"... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ...\",\n \"bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs\",\n \"in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"bs] for bs in bss] [[1, 1], [1, 1], [0, 0], [0, 0]]\",\n \"combinator library for assembling abstract definitions of logic circuits and synthesizing circuits from\",\n \"b2=None): # The inference code below is not currently in use. \\\"\\\"\\\" if\",\n \"y) in zip(self, other)]) def nand(self: bits, other) -> bits: \\\"\\\"\\\" >>> results\",\n \"0, 0, 0, 0, 0] \\\"\\\"\\\" return bits([ bit_ for byte_ in bytes_\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs < ys) ...\",\n \"results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys))\",\n \"returns an output. if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args)\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys) ...\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns =\",\n \"inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator\",\n \"from those definitions. \\\"\\\"\\\" from __future__ import annotations from typing import Sequence import\",\n \"bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v,\",\n \"True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results = [] >>>\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs &\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for\",\n \"zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self, other):\",\n \"[b.value for b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0])\",\n \"other) def imp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x,\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <= ys)\",\n \"def imp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits, other: bits)\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>> results\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in\",\n \"\\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits, other:\",\n \"bit, y: bit) -> bit: ... return (x & y) | ((1 -\",\n \">>> results = [] >>> for (x, y) in [(0, 0), (0, 1),\",\n \"representing an abstract bit. Such a bit can be interpreted concretely as a\",\n \"y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in\",\n \"bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>>\",\n \"Sequence of lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int):\",\n \"Sequence import doctest from parts import parts from circuit import op, gate, circuit,\",\n \"bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1,\",\n \"return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits, other) ->\",\n \"synthesis failed') from None # Return the original function. return f if __name__\",\n \"other)]) def nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_,\",\n \"output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_,\",\n \"= None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_\",\n \"} type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None\",\n \"\\\"\\\"\\\" Decorator for automatically synthesizing a circuit from a function that takes only\",\n \"0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits([ bit_ for byte_ in\",\n \"type annotation of the decorated function. type_in = lambda a: input(0) if a\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns =\",\n \"__add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other))\",\n \"input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated as a variable\",\n \"the wires within a circuit built up out of those operators. >>> bit.hook_operation(lambda\",\n \"for (x, y) in zip(self, other)]) def imp_(self: bits, other: bits) -> bits:\",\n \"bs in bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \\\"\\\"\\\" if\",\n \"bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits, other: bits) ->\",\n \"x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def and_(self:\",\n \"y])) ... zs = outputs(xs == ys) ... ns = [int(z) for z\",\n \"used to keep track of relationships between operators and to represent the wires\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"xor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"for a in args])) @staticmethod def constructor(b1, b2=None): # The inference code below\",\n \"\\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class\",\n \"return bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ])\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z)\",\n \"def and_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits, other: bits) ->\",\n \"constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated as a variable input.\\\"\\\"\\\" def\",\n \"1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit,\",\n \"bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def\",\n \"interpreted concretely as a value, but it is also used to keep track\",\n \"Decorator for automatically synthesizing a circuit from a function that takes only `bit`\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) &\",\n \"for (x, y) in zip(self, other)]) def nand(self: bits, other) -> bits: \\\"\\\"\\\"\",\n \">>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0 \\\"\\\"\\\" return\",\n \"bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"\\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits, other:\",\n \"for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>>\",\n \"on it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ...\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y)))\",\n \"1, 0, 0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int):\",\n \"bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if\",\n \"bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0)\",\n \"= output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self,\",\n \"return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits, other: bits)\",\n \"(0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1,\",\n \"abstract definitions of logic circuits and synthesizing circuits from those definitions. \\\"\\\"\\\" from\",\n \"def __eq__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"call last): ... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" # Functions for determining\",\n \"in use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1,\",\n \"@synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1])\",\n \"op, gate, circuit, signature class bit(): \\\"\\\"\\\" Class for representing an abstract bit.\",\n \"from parts import parts from circuit import op, gate, circuit, signature class bit():\",\n \"zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) **\",\n \"= output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self,\",\n \"other) def __and__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"for representing a vector of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit)\",\n \"other)]) def nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"determining types/signature from # the type annotation of the decorated function. type_in =\",\n \"a is bit else inputs([0] * a) type_out = lambda a: output if\",\n \"ys) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"% input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self,\",\n \"... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ...\",\n \"bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"if # it returns an output. if bit._hook_operation is not None: r =\",\n \"= outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"for (x, y) in zip(self, other)]) def __le__(self: bits, other: bits) -> bits:\",\n \"== 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the\",\n \"only `bit` and/or `bits` objects as its arguments and returns an output of\",\n \"(x, y) in zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated as a variable input from\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs <<\",\n \"y]) for x in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy)\",\n \"other) def __lt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"xy in xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2))\",\n \"others dependent on it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve\",\n \"other): \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]: ...\",\n \"other)]) def imp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\"\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]),\",\n \"in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in\",\n \"other) def __mod__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <= ys) ...\",\n \"for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1,\",\n \"... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook >>>\",\n \"... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in\",\n \"igs) def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_\",\n \"bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in ys] [1, 1,\",\n \"else other) def nimp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\"\",\n \"1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11,\",\n \"b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_,\",\n \"** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs\",\n \"True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits,\",\n \"True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\" >>> results =\",\n \">>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None\",\n \"input_two)) and b2 is None: return type(b1) else: return bit \\\"\\\"\\\" return bit\",\n \"\\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self + other def constants(l): return bits(map(constant, l))\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def\",\n \"bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self, other):\",\n \"automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing a vector of abstract\",\n \"# Number of parts is `other`. def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation\",\n \"circuit from a function that takes only `bit` and/or `bits` objects as its\",\n \"return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits, other: bits)\",\n \"in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation\",\n \"return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits, other: bits)\",\n \">>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1,\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys))\",\n \"True \\\"\\\"\\\" return bits([x.not_() for x in self]) def and_(self: bits, other: bits)\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self, other):\",\n \"outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits,\",\n \"(0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys]\",\n \"= hook @staticmethod def operation(o, *args): # Ensure second argument is a `bit`.\",\n \"bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"def nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z\",\n \"map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other) ==\",\n \"output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other)\",\n \"self, other) def imp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"\\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits, other:\",\n \"b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit())\",\n \"bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits, other: bits) ->\",\n \"= bs >> 3 >>> [b.value for b in bs] [0, 0, 0,\",\n \"bit is ready as final output or whether there are others dependent on\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y)\",\n \"a bit from the integer 1') def and_(self, other): \\\"\\\"\\\" >>> results =\",\n \"& input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self,\",\n \"| constant(0) >>> b.value 1 \\\"\\\"\\\" return self | (constant(other) if isinstance(other, int)\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\"\",\n \"bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"def if_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"an output. if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if\",\n \"__new__(cls, argument = None) -> bits: \\\"\\\"\\\" Return bits object given the supplied\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ...\",\n \"b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self, other):\",\n \"self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for\",\n \"other) def imp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"y, y])) ... zs = outputs(xs % ys) ... ns = [int(z) for\",\n \"3, 4]) >>> [[b.value for b in bs] for bs in bss] [[1],\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self,\",\n \"bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for\",\n \"make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a\",\n \"... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"return bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) ==\",\n \"0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for\",\n \"bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def\",\n \"in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0],\",\n \">>> [b.value for b in bs] [1, 1, 1, 0, 0, 0, 0,\",\n \"0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs\",\n \"b: bit): # Check if bit is ready as final output or whether\",\n \"= bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results)\",\n \"bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for\",\n \"in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b\",\n \"args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>>\",\n \"b in bs] [0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit())\",\n \">>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def\",\n \"... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"str) else a # pylint: disable=W0123 try: # Construct the circuit and add\",\n \"output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other)\",\n \"output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other)\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys) ... ns\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b)\",\n \"1, 0] \\\"\\\"\\\" def __init__(self: bit, b: bit): # Check if bit is\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs >= ys) ... ns\",\n \"zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \\\"\\\"\\\" Return\",\n \"0, 1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity =\",\n \"other)]) def xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\" >>> results =\",\n \"x]) ... ys = outputs(~xs) ... ns = [int(y) for y in ys]\",\n \"relationships between operators and to represent the wires within a circuit built up\",\n \"__init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input):\",\n \">>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last): ... ValueError:\",\n \"for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x))\",\n \"vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits:\",\n \"code below is not currently in use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2,\",\n \"... xs = inputs([x, x, x]) ... ys = outputs(~xs) ... ns =\",\n \"b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \">>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in\",\n \"(constant(other) if isinstance(other, int) else other) def or_(self, other): \\\"\\\"\\\" >>> results =\",\n \"def nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits:\",\n \"for b in bs] for bs in bss] [[1, 1], [1, 1], [0,\",\n \"bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits:\",\n \"not_(self): \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]: ...\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def\",\n \"True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\" >>> results =\",\n \"input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1)\",\n \"= output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0]\",\n \"bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits, other: bits) ->\",\n \"other) def xnor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"y]) for x in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy)\",\n \"= outputs(xs ^ ys) ... ns = [int(z) for z in zs] ...\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\"\",\n \"\\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits, other:\",\n \"\\\"\\\"\\\" Return bits object given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument,\",\n \"bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\"\",\n \"in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs\",\n \"zip(self, other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for\",\n \"__gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y)\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y)\",\n \"... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ...\",\n \"zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>>\",\n \"... ns = [int(z) for z in zs] ... c = bit.circuit() ...\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y)\",\n \"Embedded domain-specific combinator library for assembling abstract definitions of logic circuits and synthesizing\",\n \"for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>>\",\n \"bit._hook_operation(o, v, *args) if r is not None: return r return bit.constructor(*args)(v, bit.gate(o,\",\n \"[1, 3, 4]) >>> [[b.value for b in bs] for bs in bss]\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\" >>>\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns =\",\n \"self, other) def __eq__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"== input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self,\",\n \"[a.gate for a in args])) @staticmethod def constructor(b1, b2=None): # The inference code\",\n \"other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1\",\n \"nimp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_())\",\n \"bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"a function that takes only `bit` and/or `bits` objects as its arguments and\",\n \"RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" # Functions for determining types/signature from #\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns\",\n \"(x, y) in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n:\",\n \"1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0,\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs < ys) ... ns\",\n \"circuit and add it to the function as an attribute. bit.circuit(circuit()) args_in =\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self,\",\n \"v, *args) if r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y)))\",\n \"\\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"\\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits, other:\",\n \"1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>> @synthesize\",\n \"... zs = outputs(xs > ys) ... ns = [int(z) for z in\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >= ys) ...\",\n \"parts(self, other)) # Number of parts is `other`. def __add__(self: bits, other) ->\",\n \"return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits:\",\n \"== 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self,\",\n \"outputs(xs <= ys) ... ns = [int(z) for z in zs] ... c\",\n \"attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if\",\n \"as a variable input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value = value self.gate\",\n \"0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0,\",\n \"1, 1, 0, 0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0],\",\n \"# Preserve the bit by copying it to a new wire. self.value =\",\n \"bits([x.not_() for x in self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"__and__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"0, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits([ bit_ for\",\n \"y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"for (x, y) in zip(self, other)]) def nif_(self: bits, other: bits) -> bits:\",\n \"4]) >>> [[b.value for b in bs] for bs in bss] [[1], [1,\",\n \"the value of the result of the operation on the arguments. v =\",\n \"v = o(*[a.value for a in args]) # Return output from hook if\",\n \"inputs([y, y, y])) ... zs = outputs(xs & ys) ... ns = [int(z)\",\n \"1 | constant(0) >>> b.value 1 \\\"\\\"\\\" return self | (constant(other) if isinstance(other,\",\n \">>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def\",\n \"= bit._hook_operation(o, v, *args) if r is not None: return r return bit.constructor(*args)(v,\",\n \"... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"DSL for assembling logic circuits. Embedded domain-specific combinator library for assembling abstract definitions\",\n \"| ys) ... ns = [int(z) for z in zs] ... c =\",\n \"bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0,\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ...\",\n \"[1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for b in bss[0]],\",\n \"def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second argument\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\" >>>\",\n \"in zip(self, other)]) def imp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"... return x & y Traceback (most recent call last): ... RuntimeError: automated\",\n \"= outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1] \\\"\\\"\\\" return\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"\\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in\",\n \"zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"for (x, y) in zip(self, other)]) def or_(self: bits, other: bits) -> bits:\",\n \"= output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self,\",\n \"__rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value\",\n \"-> bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) ==\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self,\",\n \"... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3}\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else:\",\n \"b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_,\",\n \"constructor) ]) @staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs\",\n \"self) raise ValueError('can only subtract a bit from the integer 1') def and_(self,\",\n \"self, other) def nimp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) ==\",\n \"automated circuit synthesis failed \\\"\\\"\\\" # Functions for determining types/signature from # the\",\n \"True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits,\",\n \"\\\"\\\"\\\"Embedded DSL for assembling logic circuits. Embedded domain-specific combinator library for assembling abstract\",\n \"\\\"\\\"\\\" Class for representing an abstract bit. Such a bit can be interpreted\",\n \"bit. Such a bit can be interpreted concretely as a value, but it\",\n \"def __ge__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y)\",\n \"& (constant(other) if isinstance(other, int) else other) def nimp(self, other): \\\"\\\"\\\" >>> results\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys))\",\n \"not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def\",\n \"b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other):\",\n \"bs] for bs in bss] [[1], [1, 1, 1], [0, 0, 0, 0]]\",\n \"# pylint: disable=R0903 \\\"\\\"\\\" Class for representing an input or output type of\",\n \"None else gate_ def __int__(self): return self.value def not_(self): \\\"\\\"\\\" >>> results =\",\n \"def __or__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try: # Construct\",\n \"lambda a: output if a is bit else outputs # For forward-compatibility with\",\n \"bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>>\",\n \"= output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self)\",\n \"= output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \\\"\\\"\\\"\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns\",\n \"zip(self, other)]) def nif(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self:\",\n \"bit: ... return (x & y) | ((1 - x) & (1 -\",\n \"True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits,\",\n \"bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ...\",\n \"other)]) def xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b\",\n \"y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in zs]\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self:\",\n \"\\\"\\\"\\\" def __init__(self: bit, b: bit): # Check if bit is ready as\",\n \"zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args):\",\n \"return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the integer 1')\",\n \"= constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value of the\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\"\",\n \"= list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else\",\n \"one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated as a variable input from\",\n \"function. type_in = lambda a: input(0) if a is bit else inputs([0] *\",\n \"zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"zs = outputs(xs < ys) ... ns = [int(z) for z in zs]\",\n \"int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift\",\n \"to keep track of relationships between operators and to represent the wires within\",\n \"for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing a vector of\",\n \"[1, 1, 1], [0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list) and len(other)\",\n \"0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for\",\n \"list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1]\",\n \"input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True)\",\n \"domain-specific combinator library for assembling abstract definitions of logic circuits and synthesizing circuits\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self:\",\n \"if it exists and if # it returns an output. if bit._hook_operation is\",\n \"Preserve the bit by copying it to a new wire. self.value = b.value\",\n \"bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) ->\",\n \"return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l))\",\n \">>> def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate\",\n \"True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits,\",\n \"class bit(): \\\"\\\"\\\" Class for representing an abstract bit. Such a bit can\",\n \"= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>> [[b.value\",\n \"\\\"\\\"\\\"Bit that is designated as a variable input from a second source.\\\"\\\"\\\" class\",\n \"other) def nimp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs,\",\n \"outputs(xs >= ys) ... ns = [int(z) for z in zs] ... c\",\n \"= output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self,\",\n \"input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 -\",\n \"copying it to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate],\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\" >>>\",\n \"constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value of the result\",\n \"built up out of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>>\",\n \"def nand_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"that takes only `bit` and/or `bits` objects as its arguments and returns an\",\n \"x) & (1 - y)) >>> xys = [bits([x, y]) for x in\",\n \"for determining types/signature from # the type annotation of the decorated function. type_in\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys))\",\n \"xnor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"else inputs([0] * a) type_out = lambda a: output if a is bit\",\n \"and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length `other`. else:\",\n \"(xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for x in (0,\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\"\",\n \"b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def\",\n \"self, other) def __matmul__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ...\",\n \"[[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x,\",\n \"type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit\",\n \"self, other) def xnor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self,\",\n \"... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"- input(0) Traceback (most recent call last): ... ValueError: can only subtract a\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for\",\n \"and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None:\",\n \"= output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"last): ... ValueError: can only subtract a bit from the integer 1 \\\"\\\"\\\"\",\n \"... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"[0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs =\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >=\",\n \"input_one(input): \\\"\\\"\\\"Bit that is designated as a variable input from one source.\\\"\\\"\\\" class\",\n \"value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated as a\",\n \"a in args]) # Return output from hook if it exists and if\",\n \"= [int(y) for y in ys] ... c = bit.circuit() ... results.append(ns ==\",\n \"b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_,\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1], [0, 0,\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z)\",\n \">>> ys = outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1]\",\n \"isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for\",\n \"output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other)\",\n \"results = [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b\",\n \"= output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"... zs = outputs(xs | ys) ... ns = [int(z) for z in\",\n \"y, y])) ... zs = outputs(xs == ys) ... ns = [int(z) for\",\n \"for assembling logic circuits. Embedded domain-specific combinator library for assembling abstract definitions of\",\n \"= value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated as\",\n \"def __and__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"y])) ... zs = outputs(xs < ys) ... ns = [int(z) for z\",\n \"definitions of logic circuits and synthesizing circuits from those definitions. \\\"\\\"\\\" from __future__\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ...\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\" >>> results\",\n \"constant(1) >>> b.value 0 \\\"\\\"\\\" return self & (constant(other) if isinstance(other, int) else\",\n \"synthesizing circuits from those definitions. \\\"\\\"\\\" from __future__ import annotations from typing import\",\n \"are others dependent on it. if len(b.gate.outputs) > 0: b = ~(~b) #\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns =\",\n \"{ k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return' }\",\n \"def __init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z)\",\n \"def and_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"bss = list(bs / 2) >>> ([b.value for b in bss[0]], [b.value for\",\n \"True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\" >>> results =\",\n \">>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] &\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ...\",\n \"= output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self,\",\n \"x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ...\",\n \"self, other) def __le__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys))\",\n \"\\\"\\\"\\\" return self & (constant(other) if isinstance(other, int) else other) def nimp(self, other):\",\n \"bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for b in\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y)\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for\",\n \"in args])) @staticmethod def constructor(b1, b2=None): # The inference code below is not\",\n \"xys = [bits([x, y]) for x in (0, 1) for y in (0,\",\n \"int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is\",\n \"(most recent call last): ... ValueError: can only subtract a bit from the\",\n \"b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation = None @staticmethod def\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)])\",\n \"the type annotation of the decorated function. type_in = lambda a: input(0) if\",\n \"for z in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x,\",\n \"for (x, y) in zip(self, other)]) def nif(self: bits, other: bits) -> bits:\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ...\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b)\",\n \"True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\" >>> results =\",\n \"bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"else\\\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs\",\n \"all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self:\",\n \"bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits, other: bits) ->\",\n \"return map(bits, parts(self, other)) # Number of parts is `other`. def __add__(self: bits,\",\n \"*args) if r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for\",\n \"from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is designated an output.\",\n \"synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a circuit from a function that takes\",\n \"on the arguments. v = o(*[a.value for a in args]) # Return output\",\n \"other) def nimp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ...\",\n \"bss = list(bs / [1, 3, 4]) >>> [[b.value for b in bs]\",\n \"PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str) else a #\",\n \"y)) >>> xys = [bits([x, y]) for x in (0, 1) for y\",\n \"other) def __gt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"1 \\\"\\\"\\\" return self | (constant(other) if isinstance(other, int) else other) def nor(self,\",\n \">>> [[b.value for b in bs] for bs in bss] [[1, 1], [1,\",\n \"output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_,\",\n \"y) in zip(self, other)]) def if_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"input or output type of a function decorated for automated synthesis. \\\"\\\"\\\" class\",\n \"that is designated as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated\",\n \"args])) @staticmethod def constructor(b1, b2=None): # The inference code below is not currently\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\"\",\n \"bits([x.not_() for x in self]) def and_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits, other: bits) ->\",\n \"for (x, y) in zip(self, other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\" >>>\",\n \"for x in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for\",\n \"outputs(xs ^ ys) ... ns = [int(z) for z in zs] ... c\",\n \"other) def __eq__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"> 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths.\",\n \"2 - input(0) Traceback (most recent call last): ... ValueError: can only subtract\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\" >>> results\",\n \"@staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys))\",\n \">>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x,\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\" >>>\",\n \"True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\" >>> results =\",\n \"# For forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if isinstance(a,\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns =\",\n \"if isinstance(args[1], int) else args[1] # Compute the value of the result of\",\n \"\\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns =\",\n \"bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) ==\",\n \"for y in ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) ==\",\n \"c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self])\",\n \"return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits, other: bits)\",\n \"/ {2}) >>> [[b.value for b in bs] for bs in bss] [[1,\",\n \"__ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self,\",\n \"\\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2):\",\n \"bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"def __eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"inputs([y, y, y])) ... zs = outputs(xs | ys) ... ns = [int(z)\",\n \">>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1, 0], [1,\",\n \"pylint: disable=W0123 try: # Construct the circuit and add it to the function\",\n \"x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for y in\",\n \"return bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"__matmul__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits, other: bits) ->\",\n \"other)]) def __eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"int) else other) def or_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>>\",\n \"last): ... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" # Functions for determining types/signature\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y)))\",\n \"output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other)\",\n \"input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1,\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y))\",\n \"> 0: b = ~(~b) # Preserve the bit by copying it to\",\n \"(x, y) in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \">>> 2 - input(0) Traceback (most recent call last): ... ValueError: can only\",\n \"zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)])\",\n \"def __le__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for\",\n \"bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self,\",\n \"for (x, y) in [(0, 0), (0, 1), (1, 0), (1, 1)]: ...\",\n \">>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>>\",\n \"output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_,\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs == ys)\",\n \">>> results = [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ...\",\n \"__gt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <=\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) ==\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other)\",\n \"ys = outputs(~xs) ... ns = [int(y) for y in ys] ... c\",\n \"all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self:\",\n \"bit vectors.\\\"\\\"\\\" return self + other def constants(l): return bits(map(constant, l)) def inputs(l):\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ==\",\n \"b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_,\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs & ys) ... ns\",\n \"def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return\",\n \"y, y])) ... zs = outputs(xs ^ ys) ... ns = [int(z) for\",\n \"\\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits, other)\",\n \"is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod\",\n \"= outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b)\",\n \"= outputs(xs <= ys) ... ns = [int(z) for z in zs] ...\",\n \"= constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return\",\n \"designated as a variable input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is\",\n \"zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ...\",\n \"class input(bit): \\\"\\\"\\\"Bit that is designated as a variable input.\\\"\\\"\\\" def __init__(self: bit,\",\n \"# Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return\",\n \"for b in bs] for bs in bss] [[1], [1, 1, 1], [0,\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b)\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns =\",\n \"& xy[1]) >>> xys = [bits([x, y]) for x in (0, 1) for\",\n \"y) | ((1 - x) & (1 - y)) >>> xys = [bits([x,\",\n \"return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1,\",\n \"... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self):\",\n \"bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0\",\n \"subtract a bit from the integer 1') def and_(self, other): \\\"\\\"\\\" >>> results\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y)\",\n \"self, other) def if_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"type `bit` or `bits`. >>> @synthesize ... def equal(x: bit, y: bit) ->\",\n \"all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self:\",\n \"None: r = bit._hook_operation(o, v, *args) if r is not None: return r\",\n \"input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two))\",\n \"bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1\",\n \"vectors.\\\"\\\"\\\" return self + other def constants(l): return bits(map(constant, l)) def inputs(l): return\",\n \"args[1] # Compute the value of the result of the operation on the\",\n \"b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_,\",\n \"other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self + other def constants(l):\",\n \"and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence\",\n \"y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0,\",\n \"type(b1) else: return bit \\\"\\\"\\\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation,\",\n \"if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] #\",\n \"reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\"\",\n \"ys = outputs(xs.not_()) ... ns = [int(y) for y in ys] ... c\",\n \"for bs in bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>>\",\n \"operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1)))\",\n \"in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0)))\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z)\",\n \"automatically synthesizing a circuit from a function that takes only `bit` and/or `bits`\",\n \"-> bits: \\\"\\\"\\\" Return bits object given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for\",\n \"return bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"is bit else outputs # For forward-compatibility with PEP 563. eval_ = lambda\",\n \"\\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits, other:\",\n \"0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return\",\n \"bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self,\",\n \"and/or `bits` objects as its arguments and returns an output of type `bit`\",\n \"*args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook\",\n \"result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\"\",\n \"def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit,\",\n \"self & (constant(other) if isinstance(other, int) else other) def nimp(self, other): \\\"\\\"\\\" >>>\",\n \"zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\"\",\n \"in xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ...\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z\",\n \"class output(bit): \\\"\\\"\\\" Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0\",\n \"[equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>> @synthesize ... def\",\n \"bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>>\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs % ys)\",\n \"inputs([y, y, y])) ... zs = outputs(xs == ys) ... ns = [int(z)\",\n \"list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def\",\n \"b = 1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\" return self ^ (constant(other)\",\n \"gate_ def __int__(self): return self.value def not_(self): \\\"\\\"\\\" >>> results = [] >>>\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\" >>>\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self,\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is None else gate_\",\n \"bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"arguments. v = o(*[a.value for a in args]) # Return output from hook\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns =\",\n \"@synthesize ... def equal(x: bit, y: bit) -> bit: ... return (x &\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z)\",\n \"... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True\",\n \"(0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys]\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y)\",\n \"[[1], [1, 1, 1], [0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list) and\",\n \"return bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def\",\n \"that is designated as a variable input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs <= ys) ... ns\",\n \"== 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>>\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"assembling logic circuits. Embedded domain-specific combinator library for assembling abstract definitions of logic\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self:\",\n \"bits: \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]: ...\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self,\",\n \"None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def\",\n \"None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return\",\n \"y, y])) ... zs = outputs(xs > ys) ... ns = [int(z) for\",\n \">>> [b.value for b in bs] [0, 0, 0, 1, 1, 1, 1,\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\" >>> results\",\n \"return bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in\",\n \"if a is bit else inputs([0] * a) type_out = lambda a: output\",\n \"other) def nand(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"@staticmethod def constructor(b1, b2=None): # The inference code below is not currently in\",\n \"bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>>\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results = []\",\n \"... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"other)]) def __or__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_,\",\n \"def __le__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>>\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) ==\",\n \"imp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ...\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit\",\n \"1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0,\",\n \"# Return the original function. return f if __name__ == \\\"__main__\\\": doctest.testmod() #\",\n \"1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>\",\n \"1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(xs.not_())\",\n \"True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits,\",\n \"to represent the wires within a circuit built up out of those operators.\",\n \"for b in bs] [1, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\"\",\n \"= bs >> {3} >>> [b.value for b in bs] [1, 1, 1,\",\n \"Check if bit is ready as final output or whether there are others\",\n \"circuit_ is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit\",\n \"for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits,\",\n \"else other) def nor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"(k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit()\",\n \"import annotations from typing import Sequence import doctest from parts import parts from\",\n \"bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value\",\n \"isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two):\",\n \"-> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys\",\n \"> input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other) def\",\n \"all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results = []\",\n \"bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"= output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self,\",\n \"bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"other) def nand_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self: bits)\",\n \"output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value]\",\n \"= bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for representing\",\n \"bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit =\",\n \"x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def __invert__(self:\",\n \"f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None # Return\",\n \"inputs([x, x, x]) ... ys = outputs(~xs) ... ns = [int(y) for y\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs < ys)\",\n \"def __new__(cls, argument = None) -> bits: \\\"\\\"\\\" Return bits object given the\",\n \"return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits, other: bits)\",\n \">>> all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results =\",\n \"def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a circuit from a function that\",\n \"bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1\",\n \"bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent\",\n \"int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and\",\n \"other)]) def __le__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x))\",\n \"bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys))\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self,\",\n \"def __mod__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity])\",\n \"__future__ import annotations from typing import Sequence import doctest from parts import parts\",\n \"= None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not None:\",\n \"nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\" >>> results =\",\n \"def nif(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2})\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"self, other) def nif_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\"\",\n \"exists and if # it returns an output. if bit._hook_operation is not None:\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"self.gate = bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return self.value\",\n \"that is designated as a variable input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value\",\n \"\\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits, other:\",\n \"/ [1, 3, 4]) >>> [[b.value for b in bs] for bs in\",\n \"def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value\",\n \"\\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self: bits) ->\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def __invert__(self: bits)\",\n \"isinstance(a, str) else a # pylint: disable=W0123 try: # Construct the circuit and\",\n \"output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_,\",\n \"self, other) def nor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))\",\n \"... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"try: # Construct the circuit and add it to the function as an\",\n \"input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2 is\",\n \"y) in zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"it returns an output. if bit._hook_operation is not None: r = bit._hook_operation(o, v,\",\n \"else gate_ def __int__(self): return self.value def not_(self): \\\"\\\"\\\" >>> results = []\",\n \"bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>\",\n \"inputs([y, y, y])) ... zs = outputs(xs < ys) ... ns = [int(z)\",\n \"return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self:\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs | ys) ... ns\",\n \"1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in\",\n \"def nimp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"logic circuits and synthesizing circuits from those definitions. \\\"\\\"\\\" from __future__ import annotations\",\n \"inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z\",\n \"y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs]\",\n \"= output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self,\",\n \"[b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self: bit, b: bit): #\",\n \"\\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits, other:\",\n \"definitions. \\\"\\\"\\\" from __future__ import annotations from typing import Sequence import doctest from\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"class input_one(input): \\\"\\\"\\\"Bit that is designated as a variable input from one source.\\\"\\\"\\\"\",\n \"in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate\",\n \"xy[1]) >>> xys = [bits([x, y]) for x in (0, 1) for y\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self:\",\n \"output or whether there are others dependent on it. if len(b.gate.outputs) > 0:\",\n \"True \\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"b = ~(~b) # Preserve the bit by copying it to a new\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\" >>>\",\n \"(1 - y)) >>> xys = [bits([x, y]) for x in (0, 1)\",\n \"also used to keep track of relationships between operators and to represent the\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs %\",\n \"other) def xnor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"[a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>>\",\n \"outputs(xs == ys) ... ns = [int(z) for z in zs] ... c\",\n \"type_in = lambda a: input(0) if a is bit else inputs([0] * a)\",\n \"*args): # Ensure second argument is a `bit`. args = list(args) if len(args)\",\n \"r = bit._hook_operation(o, v, *args) if r is not None: return r return\",\n \"x in self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"def nif_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits,\",\n \"def or_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"self, other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 ^\",\n \"return bit \\\"\\\"\\\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def\",\n \"in xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) ->\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) ==\",\n \"b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0,\",\n \"outputs(xs | ys) ... ns = [int(z) for z in zs] ... c\",\n \"y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs]\",\n \"\\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other)\",\n \"abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_)\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\" >>>\",\n \">>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1,\",\n \"b.value 0 \\\"\\\"\\\" return self & (constant(other) if isinstance(other, int) else other) def\",\n \"all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results = []\",\n \"results = [] >>> for (x, y) in [(0, 0), (0, 1), (1,\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b)\",\n \"len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit by copying it\",\n \"y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs]\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)])\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for\",\n \"bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for x in [0,\",\n \"not None: r = bit._hook_operation(o, v, *args) if r is not None: return\",\n \"nor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"bs >> {3} >>> [b.value for b in bs] [1, 1, 1, 0,\",\n \"-> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_())\",\n \"self, other) def __or__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) ==\",\n \"zs = outputs(xs | ys) ... ns = [int(z) for z in zs]\",\n \"as a variable input from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that\",\n \"(x & y) | ((1 - x) & (1 - y)) >>> xys\",\n \"from a function that takes only `bit` and/or `bits` objects as its arguments\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y)\",\n \"\\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ...\",\n \"in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in\",\n \"zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\"\",\n \"return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that is designated as a constant\",\n \"for b in bs] [0, 0, 0, 1, 1, 1, 1, 0] >>>\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ==\",\n \"ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument = None) ->\",\n \"in zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return None else:\",\n \"output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other)\",\n \"** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other)\",\n \"y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in\",\n \"\\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits, other:\",\n \"-> bits: \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]:\",\n \"is bit else inputs([0] * a) type_out = lambda a: output if a\",\n \"result of the operation on the arguments. v = o(*[a.value for a in\",\n \"isinstance(other, int) else other) def nor(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \\\"\\\"\\\" Return bits object\",\n \"and to represent the wires within a circuit built up out of those\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for\",\n \"# Functions for determining types/signature from # the type annotation of the decorated\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y))\",\n \"for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b)\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns\",\n \"gate_ is None else gate_ def __int__(self): return self.value def not_(self): \\\"\\\"\\\" >>>\",\n \"\\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b\",\n \"y) in zip(self, other)]) def imp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"{3} >>> [b.value for b in bs] [1, 1, 1, 0, 0, 0,\",\n \"(x, y) in zip(self, other)]) def nif(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"For forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str)\",\n \"... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"a value, but it is also used to keep track of relationships between\",\n \"__invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for x in\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"the decorated function. type_in = lambda a: input(0) if a is bit else\",\n \"1') def and_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"\\\"\\\"\\\" Class for representing a vector of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_:\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) |\",\n \"= outputs(xs & ys) ... ns = [int(z) for z in zs] ...\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"is not currently in use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one): return\",\n \"if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit by copying\",\n \"[0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) ==\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\" >>>\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys) ... ns =\",\n \"y) in zip(self, other)]) def nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>> results\",\n \"else args[1] # Compute the value of the result of the operation on\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y))\",\n \"None # Return the original function. return f if __name__ == \\\"__main__\\\": doctest.testmod()\",\n \"bits(list): \\\"\\\"\\\" Class for representing a vector of abstract bits. \\\"\\\"\\\" @staticmethod def\",\n \"bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits, other: bits) ->\",\n \"all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self:\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"... zs = outputs(xs >= ys) ... ns = [int(z) for z in\",\n \"output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v,\",\n \"the result of the operation on the arguments. v = o(*[a.value for a\",\n \"bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation\",\n \"outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys))\",\n \"and synthesizing circuits from those definitions. \\\"\\\"\\\" from __future__ import annotations from typing\",\n \"y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs]\",\n \"if_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"in zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns\",\n \"def xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"import doctest from parts import parts from circuit import op, gate, circuit, signature\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\"\",\n \"bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits, other: bits) ->\",\n \"value: int): self.value = value self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that\",\n \"raise RuntimeError('automated circuit synthesis failed') from None # Return the original function. return\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def\",\n \"... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs == ys) ...\",\n \"outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \">>> [b.value for b in bs] [1, 0, 0, 0, 0, 0, 0,\",\n \"subtract a bit from the integer 1 \\\"\\\"\\\" if other == 1: return\",\n \"bs = bs >> {3} >>> [b.value for b in bs] [1, 1,\",\n \"eval_ = lambda a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123\",\n \"True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\" >>> results =\",\n \"y) in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ...\",\n \"... zs = outputs(xs <= ys) ... ns = [int(z) for z in\",\n \"__xor__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except:\",\n \"designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_())\",\n \"zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\" >>> results\",\n \"constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in\",\n \"bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3,\",\n \"output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other)\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self,\",\n \">>> @synthesize ... def equal(x, y): ... return x & y Traceback (most\",\n \"# Return output from hook if it exists and if # it returns\",\n \"bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs]\",\n \"y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in zs]\",\n \"... def equal(x, y): ... return x & y Traceback (most recent call\",\n \"bit by copying it to a new wire. self.value = b.value self.gate =\",\n \"\\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>> [[b.value for\",\n \"b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self,\",\n \"= list(bs / {2}) >>> [[b.value for b in bs] for bs in\",\n \"\\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"in zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for\",\n \"r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\" >>>\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys))\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def\",\n \"constant(0) >>> b.value 1 \\\"\\\"\\\" return self | (constant(other) if isinstance(other, int) else\",\n \"True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that is designated as\",\n \"hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ...\",\n \"\\\"\\\"\\\"Bit that is designated as a variable input.\\\"\\\"\\\" def __init__(self: bit, value: int):\",\n \"def nor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"value self.gate = bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\" >>> results\",\n \"y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs]\",\n \"__ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)])\",\n \"[1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0]\",\n \"input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else: return\",\n \">>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call\",\n \"y) in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"def __xor__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\"\",\n \"outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self)))\",\n \"bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \\\"\\\"\\\" Return bits object given\",\n \"\\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other)\",\n \"= outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"list) and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) #\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ...\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x,\",\n \"... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit,\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y)\",\n \"... ns = [int(y) for y in ys] ... c = bit.circuit() ...\",\n \"all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self:\",\n \"isinstance(other, int) else other) def or_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits, other: bits) ->\",\n \"else: return bit \\\"\\\"\\\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs)\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"ns = [int(y) for y in ys] ... c = bit.circuit() ... results.append(ns\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for\",\n \"a is bit else outputs # For forward-compatibility with PEP 563. eval_ =\",\n \">>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit\",\n \"def nand(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"__mod__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"return bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b =\",\n \"-> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1,\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs % ys) ... ns\",\n \"1, 0, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits([ bit_\",\n \"@staticmethod def operation(o, *args): # Ensure second argument is a `bit`. args =\",\n \"1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))\",\n \"__eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"= output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit())\",\n \"parts from circuit import op, gate, circuit, signature class bit(): \\\"\\\"\\\" Class for\",\n \"xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y)\",\n \"in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"bs >> 3 >>> [b.value for b in bs] [0, 0, 0, 1,\",\n \"(0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>>\",\n \"a `bit`. args = list(args) if len(args) == 2: args[1] = constant(args[1]) if\",\n \"[b.value for b in bs] [0, 0, 0, 1, 1, 1, 1, 0]\",\n \"for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b\",\n \"b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_,\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y)))\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def\",\n \"[1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>> [[b.value for b\",\n \"`bits` objects as its arguments and returns an output of type `bit` or\",\n \">>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0,\",\n \"map(bits, parts(self, other)) # Number of parts is `other`. def __add__(self: bits, other)\",\n \"of lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return\",\n \"y) in zip(self, other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\" >>> results =\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys))\",\n \"[[b.value for b in bs] for bs in bss] [[1, 1], [1, 1],\",\n \"1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0]\",\n \"inputs([0] * a) type_out = lambda a: output if a is bit else\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \">>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ...\",\n \"/ 2) >>> ([b.value for b in bss[0]], [b.value for b in bss[1]])\",\n \"bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list)\",\n \"an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items()\",\n \"k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in))\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z\",\n \"parts is `other`. def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\"\",\n \"zs = outputs(xs <= ys) ... ns = [int(z) for z in zs]\",\n \"b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>>\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\" >>>\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <\",\n \">= ys) ... ns = [int(z) for z in zs] ... c =\",\n \"in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"logic circuits. Embedded domain-specific combinator library for assembling abstract definitions of logic circuits\",\n \"... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ...\",\n \"\\\"\\\"\\\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit,\",\n \"an input or output type of a function decorated for automated synthesis. \\\"\\\"\\\"\",\n \"self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903\",\n \"isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) **\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z\",\n \"(x, y) in zip(self, other)]) def imp(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"zip(self, other)]) def xor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"Functions for determining types/signature from # the type annotation of the decorated function.\",\n \"if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if r is\",\n \"return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits, other: bits)\",\n \"True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits,\",\n \"b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args): ...\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ...\",\n \"bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a circuit from a\",\n \"other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l):\",\n \"b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_,\",\n \"True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits,\",\n \"nand_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\" >>> results =\",\n \">>> xys = [bits([x, y]) for x in (0, 1) for y in\",\n \"def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self +\",\n \"__lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))\",\n \"bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def\",\n \"def not_(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for x\",\n \"a circuit from a function that takes only `bit` and/or `bits` objects as\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs > ys)\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys))\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns =\",\n \"(x, y) in zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"y])) ... zs = outputs(xs > ys) ... ns = [int(z) for z\",\n \"bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_()\",\n \"self]) def and_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else: return bit\",\n \"... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis\",\n \"[[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ...\",\n \"bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for b in\",\n \"^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self,\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\" >>>\",\n \"\\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits, other:\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self, other):\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"inference code below is not currently in use. \\\"\\\"\\\" if isinstance(b1, input_one) and\",\n \"isinstance(other, int) else other) def nimp(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns\",\n \"... zs = outputs(xs == ys) ... ns = [int(z) for z in\",\n \"is None else gate_ def __int__(self): return self.value def not_(self): \\\"\\\"\\\" >>> results\",\n \"| ((1 - x) & (1 - y)) >>> xys = [bits([x, y])\",\n \"x in self]) def and_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def\",\n \"output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2\",\n \"y) in zip(self, other)]) def nor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"if other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit\",\n \"True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\" >>> results =\",\n \"xor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None #\",\n \"xy in xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize\",\n \">>> [[b.value for b in bs] for bs in bss] [[1], [1, 1,\",\n \"_circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not\",\n \">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2)\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ...\",\n \"in zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"return x & y Traceback (most recent call last): ... RuntimeError: automated circuit\",\n \"`bit` and/or `bits` objects as its arguments and returns an output of type\",\n \"[(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b =\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def and_(self: bits,\",\n \"... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>>\",\n \"[0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for b in bs]\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) ==\",\n \"(x, y) in [(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit())\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ...\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)])\",\n \"it to the function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a))\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ...\",\n \"outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"synthesis failed \\\"\\\"\\\" # Functions for determining types/signature from # the type annotation\",\n \">>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^\",\n \"bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits, other: bits) ->\",\n \"bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits, other) -> bits:\",\n \"l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a circuit from a function\",\n \"isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else: return bit \\\"\\\"\\\"\",\n \"def __int__(self): return self.value def not_(self): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"[1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for b in bs]\",\n \"0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)])\",\n \"[y.value for y in ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls,\",\n \"... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ...\",\n \"b = 0 & constant(1) >>> b.value 0 \\\"\\\"\\\" return self & (constant(other)\",\n \"library for assembling abstract definitions of logic circuits and synthesizing circuits from those\",\n \"[[b.value for b in bs] for bs in bss] [[1], [1, 1, 1],\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other)\",\n \"... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"def not_(self): \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]:\",\n \"xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits,\",\n \"rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs\",\n \"bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"\\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits,\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs & ys)\",\n \"True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\" >>> results =\",\n \"bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def\",\n \"inputs([y, y, y])) ... zs = outputs(xs > ys) ... ns = [int(z)\",\n \"... zs = outputs(xs < ys) ... ns = [int(z) for z in\",\n \"imp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"a variable input from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is\",\n \"\\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits, other:\",\n \"bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self: bits, other: bits)\",\n \"* a) type_out = lambda a: output if a is bit else outputs\",\n \"function decorated for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing a\",\n \"circuit import op, gate, circuit, signature class bit(): \\\"\\\"\\\" Class for representing an\",\n \"b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_,\",\n \"(len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self, other)) # Number\",\n \"a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated as a variable input.\\\"\\\"\\\"\",\n \"for xy in xys] [[1], [0], [0], [1]] >>> @synthesize ... def conjunction(xy:\",\n \"def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is\",\n \"bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits, other: bits) ->\",\n \"== bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args): ... return\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y))\",\n \"= outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"for representing an input or output type of a function decorated for automated\",\n \"bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"up out of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit())\",\n \"for (x, y) in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits:\",\n \"-> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result) def\",\n \"output if a is bit else outputs # For forward-compatibility with PEP 563.\",\n \"in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0])\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)])\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def\",\n \"in bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>>\",\n \"inputs([y, y, y])) ... zs = outputs(xs <= ys) ... ns = [int(z)\",\n \"bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self + other def\",\n \"to the function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for\",\n \"bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs\",\n \"other)]) def __lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits,\",\n \"True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits,\",\n \"__xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"- x) & (1 - y)) >>> xys = [bits([x, y]) for x\",\n \"0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit,\",\n \">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y))\",\n \"for (x, y) in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits:\",\n \"x in (0, 1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy\",\n \"self, other) def imp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"else outputs # For forward-compatibility with PEP 563. eval_ = lambda a: eval(a)\",\n \"y, y])) ... zs = outputs(xs < ys) ... ns = [int(z) for\",\n \"from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for\",\n \"2) >>> ([b.value for b in bss[0]], [b.value for b in bss[1]]) ([1,\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\"\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z\",\n \"all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self:\",\n \"b in bs] [1, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return\",\n \"for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit)\",\n \"[b.value for b in bs] [1, 1, 1, 0, 0, 0, 0, 1]\",\n \"a circuit built up out of those operators. >>> bit.hook_operation(lambda o, v, *args:\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b)\",\n \"__init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is None\",\n \"if gate_ is None else gate_ def __int__(self): return self.value def not_(self): \\\"\\\"\\\"\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>> results = [] >>> for x\",\n \"bs in bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit())\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x,\",\n \"True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits,\",\n \"reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y)\",\n \"bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1 \\\"\\\"\\\" return self\",\n \"b in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit())\",\n \"0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs /\",\n \"= outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for\",\n \"concretely as a value, but it is also used to keep track of\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns =\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs < ys) ... ns =\",\n \"Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>>\",\n \">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value\",\n \"... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for x\",\n \"represent the wires within a circuit built up out of those operators. >>>\",\n \"bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self, other):\",\n \"bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits, other) -> bits:\",\n \"a: output if a is bit else outputs # For forward-compatibility with PEP\",\n \"Parts of length `other`. else: return map(bits, parts(self, other)) # Number of parts\",\n \"return bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1,\",\n \"isinstance(args[1], int) else args[1] # Compute the value of the result of the\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b)\",\n \"[0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list) and len(other) > 0 and\",\n \"other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ...\",\n \"bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits, other: bits) ->\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y)\",\n \"for y in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x,\",\n \"returns an output of type `bit` or `bits`. >>> @synthesize ... def equal(x:\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"imp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ...\",\n \"inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z\",\n \"bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nimp_(self: bits, other: bits) ->\",\n \"y) in zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"as a variable input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated\",\n \"... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0],\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y)\",\n \"y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in zs]\",\n \"... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"lambda a: input(0) if a is bit else inputs([0] * a) type_out =\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns\",\n \"... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"(x, y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded\",\n \"== bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most\",\n \"return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self: bits, other: bits)\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x,\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b)\",\n \"list(bs / {2}) >>> [[b.value for b in bs] for bs in bss]\",\n \"other)]) def __gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def __invert__(self: bits) ->\",\n \"int) else\\\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"\\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits, other:\",\n \"other)]) def __ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"= output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"bit) -> bit: ... return (x & y) | ((1 - x) &\",\n \"inputs([y, y, y])) ... zs = outputs(xs ^ ys) ... ns = [int(z)\",\n \"results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x\",\n \"circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable()\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\" >>>\",\n \"y) in zip(self, other)]) def xor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"in zip(self, other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self:\",\n \"def __lt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"y, y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in\",\n \"\\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits, other:\",\n \"self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int):\",\n \"recent call last): ... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" # Functions for\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <\",\n \"0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits([ bit_ for byte_\",\n \"x, x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ...\",\n \"sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\"\",\n \"& (1 - y)) >>> xys = [bits([x, y]) for x in (0,\",\n \"# Sequence of lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0],\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b)\",\n \"... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ...\",\n \"= list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of\",\n \"0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self:\",\n \"output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_,\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self, other):\",\n \"by copying it to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_,\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) =\",\n \"y, y])) ... zs = outputs(xs | ys) ... ns = [int(z) for\",\n \"^ ys) ... ns = [int(z) for z in zs] ... c =\",\n \"b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class\",\n \"other) def nor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint:\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns =\",\n \"return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits, other: bits)\",\n \"1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0])\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) ==\",\n \"... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other) -> bits:\",\n \"(most recent call last): ... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" # Functions\",\n \"hook @staticmethod def operation(o, *args): # Ensure second argument is a `bit`. args\",\n \"self, other) def nand_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"... zs = outputs(xs ^ ys) ... ns = [int(z) for z in\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"__pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self + other\",\n \"return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results = [] >>> for x\",\n \"is designated as a variable input from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\"\",\n \"\\\"\\\"\\\" return self | (constant(other) if isinstance(other, int) else other) def nor(self, other):\",\n \"-> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y])\",\n \"o(*[a.value for a in args]) # Return output from hook if it exists\",\n \"return bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"= list(bs / 2) >>> ([b.value for b in bss[0]], [b.value for b\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ...\",\n \"y) in zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def\",\n \"True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\" >>> results =\",\n \"bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ^\",\n \"self, other) def __ge__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"in bs] for bs in bss] [[1, 1], [1, 1], [0, 0], [0,\",\n \"# Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\"\",\n \"zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"inputs([y, y, y])) ... zs = outputs(xs >= ys) ... ns = [int(z)\",\n \"if isinstance(other, int) else other) def nor(self, other): \\\"\\\"\\\" >>> results = []\",\n \"operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >>\",\n \"int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self:\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y)))\",\n \"of the decorated function. type_in = lambda a: input(0) if a is bit\",\n \"... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"\\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two\",\n \"bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0, 0),\",\n \">>> all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results =\",\n \"y) in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"0, 0]] \\\"\\\"\\\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int):\",\n \"in self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"disable=R0903 \\\"\\\"\\\" Class for representing an input or output type of a function\",\n \"Construct the circuit and add it to the function as an attribute. bit.circuit(circuit())\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs | ys) ...\",\n \"designated as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated as a\",\n \"= output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self,\",\n \"in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) ->\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"import parts from circuit import op, gate, circuit, signature class bit(): \\\"\\\"\\\" Class\",\n \"bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\" >>>\",\n \"for (x, y) in zip(self, other)]) def __and__(self: bits, other: bits) -> bits:\",\n \"None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit\",\n \"isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set)\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\"\",\n \"outputs # For forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if\",\n \"y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in\",\n \"disable=W0123 try: # Construct the circuit and add it to the function as\",\n \"for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"from hook if it exists and if # it returns an output. if\",\n \"True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last): ...\",\n \"as its arguments and returns an output of type `bit` or `bits`. >>>\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\"\",\n \"... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other)\",\n \"| input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self,\",\n \"b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_,\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results\",\n \"inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z\",\n \"bs = bs << 3 >>> [b.value for b in bs] [1, 0,\",\n \"circuit, signature class bit(): \\\"\\\"\\\" Class for representing an abstract bit. Such a\",\n \"b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_,\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self:\",\n \"zs = outputs(xs % ys) ... ns = [int(z) for z in zs]\",\n \"def __or__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"int) else other) def nor(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"def imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is designated an output. >>> bit.circuit(circuit()) >>>\",\n \"bs] [1, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) **\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other)\",\n \"return bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns =\",\n \"= list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other])\",\n \"bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z)\",\n \"inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns =\",\n \"def xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"= bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated as a variable input\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y))\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs > ys) ...\",\n \"args = list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int)\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self, other):\",\n \"1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys))\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z)\",\n \"b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"__lt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for\",\n \"\\\"\\\"\\\" Class for representing an input or output type of a function decorated\",\n \"annotation of the decorated function. type_in = lambda a: input(0) if a is\",\n \"or whether there are others dependent on it. if len(b.gate.outputs) > 0: b\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self, other): \\\"\\\"\\\" >>> results\",\n \"bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for\",\n \"return bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b =\",\n \"bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second argument is a\",\n \"\\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits, other:\",\n \"def nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"0: b = ~(~b) # Preserve the bit by copying it to a\",\n \"1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\" return self ^ (constant(other) if isinstance(other,\",\n \"bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"self, other) def nand(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \">>> bs = bs >> {3} >>> [b.value for b in bs] [1,\",\n \"output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_,\",\n \"ready as final output or whether there are others dependent on it. if\",\n \"as a value, but it is also used to keep track of relationships\",\n \"argument = None) -> bits: \\\"\\\"\\\" Return bits object given the supplied argument.\",\n \"self + other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l))\",\n \"(x, y) in zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b\",\n \"for (x, y) in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits:\",\n \"0]] \\\"\\\"\\\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\" >>> results\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\" >>> results\",\n \"0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x, y):\",\n \"else: return map(bits, parts(self, other)) # Number of parts is `other`. def __add__(self:\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b)\",\n \"args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k !=\",\n \"y) in zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in\",\n \"-> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self + other def constants(l): return\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ...\",\n \"== c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for x in\",\n \"zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys\",\n \"\\\"\\\"\\\" # Functions for determining types/signature from # the type annotation of the\",\n \"from typing import Sequence import doctest from parts import parts from circuit import\",\n \"& y Traceback (most recent call last): ... RuntimeError: automated circuit synthesis failed\",\n \"== ys) ... ns = [int(z) for z in zs] ... c =\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif\",\n \"... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"= output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self,\",\n \"bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \\\"\\\"\\\"\",\n \">>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True\",\n \"0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs /\",\n \"or `bits`. >>> @synthesize ... def equal(x: bit, y: bit) -> bit: ...\",\n \"outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\"\",\n \"y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in zs]\",\n \"all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self:\",\n \"([b.value for b in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1,\",\n \"bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"currently in use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @\",\n \"def xnor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def __lt__(self: bits,\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) ==\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b)\",\n \"bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that is designated as a constant input.\\\"\\\"\\\"\",\n \"output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other)\",\n \"__mod__(self, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b)\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"designated as a variable input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value = value\",\n \"1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length `other`.\",\n \"circuits and synthesizing circuits from those definitions. \\\"\\\"\\\" from __future__ import annotations from\",\n \"def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args]))\",\n \"bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>>\",\n \"[bits([x, y]) for x in (0, 1) for y in (0, 1)] >>>\",\n \"@staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value =\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\" >>>\",\n \"self.value def not_(self): \\\"\\\"\\\" >>> results = [] >>> for x in [0,\",\n \"x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) ==\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self,\",\n \"dependent on it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the\",\n \"1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs =\",\n \"y])) ... zs = outputs(xs & ys) ... ns = [int(z) for z\",\n \"with PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str) else a\",\n \"`bit`. args = list(args) if len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1],\",\n \"bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits, other: bits) ->\",\n \"\\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ...\",\n \"len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of\",\n \"results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return\",\n \"nor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))]\",\n \"y])) ... zs = outputs(xs | ys) ... ns = [int(z) for z\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) ==\",\n \"length `other`. else: return map(bits, parts(self, other)) # Number of parts is `other`.\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs | ys) ... ns =\",\n \"= lambda a: input(0) if a is bit else inputs([0] * a) type_out\",\n \">>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 =\",\n \"... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\" return bits([x.not_() for\",\n \">>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation = None @staticmethod\",\n \"nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"y, y])) ... zs = outputs(xs & ys) ... ns = [int(z) for\",\n \"outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a circuit\",\n \"other) def nif_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\" >>> results =\",\n \"`other`. def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result =\",\n \"y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for z in\",\n \"True \\\"\\\"\\\" return bits([x.not_() for x in self]) def __invert__(self: bits) -> bits:\",\n \"xs = inputs([x, x, x]) ... ys = outputs(~xs) ... ns = [int(y)\",\n \"Class for representing a vector of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int,\",\n \"for (x, y) in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits:\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs & ys) ... ns =\",\n \"isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: #\",\n \"2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\" >>> results\",\n \"gate, circuit, signature class bit(): \\\"\\\"\\\" Class for representing an abstract bit. Such\",\n \"isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and b2\",\n \"return self.value def not_(self): \\\"\\\"\\\" >>> results = [] >>> for x in\",\n \"self | (constant(other) if isinstance(other, int) else other) def nor(self, other): \\\"\\\"\\\" >>>\",\n \"`bits`. >>> @synthesize ... def equal(x: bit, y: bit) -> bit: ... return\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>> results =\",\n \"... ys = outputs(xs.not_()) ... ns = [int(y) for y in ys] ...\",\n \"for a in args]) # Return output from hook if it exists and\",\n \"\\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that is designated\",\n \"self, other) class constant(bit): \\\"\\\"\\\"Bit that is designated as a constant input.\\\"\\\"\\\" class\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ...\",\n \"constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i)\",\n \"Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs\",\n \"bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for representing an\",\n \"return bits([x.not_() for x in self]) def and_(self: bits, other: bits) -> bits:\",\n \"= output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self,\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self:\",\n \"((1 - x) & (1 - y)) >>> xys = [bits([x, y]) for\",\n \"(x, y) in zip(self, other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\" >>> results\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y))\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"# Parts of length `other`. else: return map(bits, parts(self, other)) # Number of\",\n \"or_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"__init__(self: bit, b: bit): # Check if bit is ready as final output\",\n \"zip(self, other)]) def nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"bit.circuit(circuit()) ... b = output(1 - input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results)\",\n \"is also used to keep track of relationships between operators and to represent\",\n \"... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self: bit, b:\",\n \"\\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits, other:\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) ==\",\n \"class bits(list): \\\"\\\"\\\" Class for representing a vector of abstract bits. \\\"\\\"\\\" @staticmethod\",\n \"... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated as a variable input.\\\"\\\"\\\" def __init__(self:\",\n \"True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\" >>> results =\",\n \"\\\"\\\"\\\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return map(bits,\",\n \"variable input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated as a\",\n \"r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None):\",\n \"from circuit import op, gate, circuit, signature class bit(): \\\"\\\"\\\" Class for representing\",\n \"True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\" >>> results =\",\n \"bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_):\",\n \"= ~(~b) # Preserve the bit by copying it to a new wire.\",\n \"= output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self,\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs == ys) ... ns =\",\n \"True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self:\",\n \"0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits,\",\n \"__le__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"in bs] [1, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:])\",\n \"in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"def nor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated as a variable\",\n \"bs = bs >> 3 >>> [b.value for b in bs] [0, 0,\",\n \"outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"raise ValueError('can only subtract a bit from the integer 1') def and_(self, other):\",\n \"bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"= [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs =\",\n \"= bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None # Return the\",\n \"\\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that is designated as a\",\n \"def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\"\",\n \"args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute the value of\",\n \"outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"return bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self: bit, b: bit): # Check if\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ...\",\n \"for (x, y) in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits:\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\"\",\n \"Traceback (most recent call last): ... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" #\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"def nand(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"zs = outputs(xs == ys) ... ns = [int(z) for z in zs]\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b)\",\n \"def imp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"if a is bit else outputs # For forward-compatibility with PEP 563. eval_\",\n \"other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0, 0),\",\n \"if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \\\"\\\"\\\" >>>\",\n \"def if_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"= outputs(xs.nif_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"argument is a `bit`. args = list(args) if len(args) == 2: args[1] =\",\n \"self, other) def __xor__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit): \\\"\\\"\\\"Bit that is\",\n \"in zip(self, other)]) def nif(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"for (x, y) in zip(self, other)]) def imp(self: bits, other: bits) -> bits:\",\n \"isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0])\",\n \"= inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for\",\n \"(x, y) in zip(self, other)]) def nor(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"< ys) ... ns = [int(z) for z in zs] ... c =\",\n \"all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last):\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b)\",\n \"ns = [int(z) for z in zs] ... c = bit.circuit() ... results.append(ns\",\n \"0, 0] \\\"\\\"\\\" return bits([ bit_ for byte_ in bytes_ for bit_ in\",\n \"zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"(x, y) in zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"563. eval_ = lambda a: eval(a) if isinstance(a, str) else a # pylint:\",\n \"self, other) def __gt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"= 1 | constant(0) >>> b.value 1 \\\"\\\"\\\" return self | (constant(other) if\",\n \"in zip(self, other)]) def nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>> results =\",\n \"variable input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value = value self.gate = bit._circuit.gate(op.id_,\",\n \"_hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit =\",\n \"x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for y in ys]\",\n \"self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"for x in self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for b\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self, other):\",\n \">>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\" return\",\n \"length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other) == 1 and\",\n \"bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>\",\n \"as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in\",\n \"int) else args[1] # Compute the value of the result of the operation\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ...\",\n \"\\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self: bits, other:\",\n \"def equal(x: bit, y: bit) -> bit: ... return (x & y) |\",\n \"return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other)\",\n \"the arguments. v = o(*[a.value for a in args]) # Return output from\",\n \"<= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self,\",\n \"/ (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self, other)) #\",\n \"y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs]\",\n \"__invert__(self): \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]: ...\",\n \"nand(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \">>> b = 1 | constant(0) >>> b.value 1 \\\"\\\"\\\" return self |\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x,\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x,\",\n \"bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ...\",\n \"= output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"y in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x]))\",\n \"y: bit) -> bit: ... return (x & y) | ((1 - x)\",\n \"xor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"= bs << 3 >>> [b.value for b in bs] [1, 0, 0,\",\n \"... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"__rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation and shift operations. >>>\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for\",\n \"return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): #\",\n \"True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits,\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs | ys)\",\n \"zip(self, other)]) def imp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"of length `other`. else: return map(bits, parts(self, other)) # Number of parts is\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>>\",\n \"for (x, y) in zip(self, other)]) def nand_(self: bits, other) -> bits: \\\"\\\"\\\"\",\n \"synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing a vector of abstract bits.\",\n \"in zip(self, other)]) def if_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"import op, gate, circuit, signature class bit(): \\\"\\\"\\\" Class for representing an abstract\",\n \"\\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits, other:\",\n \"shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs\",\n \"return bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b =\",\n \"a vector of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits:\",\n \"Such a bit can be interpreted concretely as a value, but it is\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor_(ys))\",\n \"other)]) def __mod__(self, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"def nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits, other: bits)\",\n \">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y)))\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"results = [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs\",\n \"operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>\",\n \"def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b in\",\n \"imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0])\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self,\",\n \"class input_two(input): \\\"\\\"\\\"Bit that is designated as a variable input from a second\",\n \"= b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\"\",\n \"-> bit: ... return (x & y) | ((1 - x) & (1\",\n \"= bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return self.value def\",\n \"zip(self, other)]) def if_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b =\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"of a function decorated for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for\",\n \"0, 0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int): #\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\" >>>\",\n \"bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results = [] >>> for x in\",\n \"set) and len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) #\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z)\",\n \"= o(*[a.value for a in args]) # Return output from hook if it\",\n \"... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"b.value 1 \\\"\\\"\\\" return self ^ (constant(other) if isinstance(other, int) else other) def\",\n \"bit._circuit.gate() if gate_ is None else gate_ def __int__(self): return self.value def not_(self):\",\n \"v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return\",\n \"bit(): \\\"\\\"\\\" Class for representing an abstract bit. Such a bit can be\",\n \"nimp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"... RuntimeError: automated circuit synthesis failed \\\"\\\"\\\" # Functions for determining types/signature from\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) ==\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ...\",\n \"else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o,\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y))\",\n \"variable input from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is designated\",\n \"b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_,\",\n \"([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs =\",\n \"= None) -> bits: \\\"\\\"\\\" Return bits object given the supplied argument. \\\"\\\"\\\"\",\n \"xnor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self, other):\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) ==\",\n \"for (k, a) in f.__annotations__.items() if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit =\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in\",\n \"0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >>\",\n \"x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 - input(x)) ...\",\n \"return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one,\",\n \"there are others dependent on it. if len(b.gate.outputs) > 0: b = ~(~b)\",\n \"= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for b\",\n \"all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self:\",\n \"@staticmethod def circuit(circuit_=None): if circuit_ is not None: bit._circuit = circuit_ return None\",\n \"1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results)\",\n \"bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"__rsub__(self, other): \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]:\",\n \"second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is designated an output. >>> bit.circuit(circuit())\",\n \"[0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0],\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y)))\",\n \"only subtract a bit from the integer 1 \\\"\\\"\\\" if other == 1:\",\n \"return bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self, other):\",\n \"def or_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self: bits,\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs > ys) ... ns =\",\n \"Class for representing an abstract bit. Such a bit can be interpreted concretely\",\n \"0, 0, 0] \\\"\\\"\\\" return bits([ bit_ for byte_ in bytes_ for bit_\",\n \"y) in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"equal(x, y): ... return x & y Traceback (most recent call last): ...\",\n \"y])) ... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in zs]\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self, other):\",\n \"\\\"\\\"\\\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value,\",\n \"return bit_.constructor(*args)(v, bit_.gate(o, [a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit))\",\n \"return bit.operation(op.nimp_, self, other) def nimp_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"% ys) ... ns = [int(z) for z in zs] ... c =\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs |\",\n \"# Check if bit is ready as final output or whether there are\",\n \"given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument)\",\n \"b.value 1 \\\"\\\"\\\" return self | (constant(other) if isinstance(other, int) else other) def\",\n \"... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\"\",\n \"o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value ==\",\n \"def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self)\",\n \"zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits, other) ->\",\n \"ValueError: can only subtract a bit from the integer 1 \\\"\\\"\\\" if other\",\n \"forward-compatibility with PEP 563. eval_ = lambda a: eval(a) if isinstance(a, str) else\",\n \"x, x]) ... ys = outputs(~xs) ... ns = [int(y) for y in\",\n \"range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value\",\n \"return bits([x.not_() for x in self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"\\\"\\\"\\\" return bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor)\",\n \"bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) ->\",\n \"list(bs / 2) >>> ([b.value for b in bss[0]], [b.value for b in\",\n \"0, 0, 0, 0] \\\"\\\"\\\" return bits([ bit_ for byte_ in bytes_ for\",\n \"inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z\",\n \"only subtract a bit from the integer 1') def and_(self, other): \\\"\\\"\\\" >>>\",\n \"{2}) >>> [[b.value for b in bs] for bs in bss] [[1, 1],\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1 \\\"\\\"\\\"\",\n \"zip(self, other)]) def nand(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"a bit can be interpreted concretely as a value, but it is also\",\n \"\\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits, other)\",\n \"def xor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"circuit built up out of those operators. >>> bit.hook_operation(lambda o, v, *args: None)\",\n \"self, other) def xnor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\" >>> results\",\n \"bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for z\",\n \"for (x, y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\"\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self, other):\",\n \"int) else other) def nimp(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns\",\n \"- y)) >>> xys = [bits([x, y]) for x in (0, 1) for\",\n \"... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"self, other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 |\",\n \"b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_,\",\n \"b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self: bit, b: bit): # Check\",\n \"... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"b in bs] for bs in bss] [[1], [1, 1, 1], [0, 0,\",\n \"return (x & y) | ((1 - x) & (1 - y)) >>>\",\n \"wires within a circuit built up out of those operators. >>> bit.hook_operation(lambda o,\",\n \"0 \\\"\\\"\\\" return self & (constant(other) if isinstance(other, int) else other) def nimp(self,\",\n \"__and__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \">>> [y.value for y in ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def\",\n \"[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1\",\n \"below is not currently in use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one):\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\" >>>\",\n \"outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"\\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"for x in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self:\",\n \"in zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"[0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>>\",\n \"= outputs(xs.nor(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a)\",\n \"= output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"output type of a function decorated for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\"\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\" >>>\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x,\",\n \"= outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"def __xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for b\",\n \"@synthesize ... def equal(x, y): ... return x & y Traceback (most recent\",\n \"bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(~xs) ... ns\",\n \"= outputs(xs < ys) ... ns = [int(z) for z in zs] ...\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys))\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self,\",\n \"= output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self)\",\n \"outputs(xs.not_()) ... ns = [int(y) for y in ys] ... c = bit.circuit()\",\n \"True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\" >>> results =\",\n \"= lambda a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try:\",\n \"def nimp_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"y) in zip(self, other)]) def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded operator:\",\n \"(x, y) in zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"operation(o, *args): # Ensure second argument is a `bit`. args = list(args) if\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y))\",\n \"\\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def nand_(self: bits, other)\",\n \">>> bs = bs << 3 >>> [b.value for b in bs] [1,\",\n \"in bs] [1, 1, 1, 0, 0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other,\",\n \"= bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for b\",\n \"y) in zip(self, other)]) def or_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"y])) ... zs = outputs(xs ^ ys) ... ns = [int(z) for z\",\n \"def __int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0,\",\n \"... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"in zip(self, other)]) def nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\"\",\n \"- input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2\",\n \"def outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a\",\n \"if k != 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z)\",\n \"bit else outputs # For forward-compatibility with PEP 563. eval_ = lambda a:\",\n \"... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other)\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ...\",\n \"return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None): #\",\n \"equal(x: bit, y: bit) -> bit: ... return (x & y) | ((1\",\n \"bit else inputs([0] * a) type_out = lambda a: output if a is\",\n \">>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]] >>> @synthesize ...\",\n \"outputs(xs.nif(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"... zs = outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"True \\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"if isinstance(a, str) else a # pylint: disable=W0123 try: # Construct the circuit\",\n \"circuit synthesis failed') from None # Return the original function. return f if\",\n \"True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \">>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>>\",\n \"bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"= outputs(xs.nand(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"self, other) def __mod__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"a function decorated for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing\",\n \"add it to the function as an attribute. bit.circuit(circuit()) args_in = { k:\",\n \"nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\" >>> results\",\n \"constant(0) >>> b.value 1 \\\"\\\"\\\" return self ^ (constant(other) if isinstance(other, int) else\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self, other):\",\n \"return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self: bits, other: bits)\",\n \"output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other)\",\n \"def imp(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"is None: return type(b1) else: return bit \\\"\\\"\\\" return bit @staticmethod def gate(operation,\",\n \"y) in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ...\",\n \"return bits(result) def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return\",\n \"if bit is ready as final output or whether there are others dependent\",\n \"in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_, constructor=bit) -> bits:\",\n \"in ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument = None)\",\n \"zs = outputs(xs > ys) ... ns = [int(z) for z in zs]\",\n \"... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ...\",\n \"(x, y) in zip(self, other)]) def xnor(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"zip(self, other)]) def nor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None):\",\n \">>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(1 -\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >\",\n \"[0, 1, 0] \\\"\\\"\\\" def __init__(self: bit, b: bit): # Check if bit\",\n \"in bs] [0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>>\",\n \"nand(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"... zs = outputs(xs % ys) ... ns = [int(z) for z in\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs % ys) ...\",\n \"\\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"zs = outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"# Construct the circuit and add it to the function as an attribute.\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys))\",\n \"of bit vectors.\\\"\\\"\\\" return self + other def constants(l): return bits(map(constant, l)) def\",\n \"output of type `bit` or `bits`. >>> @synthesize ... def equal(x: bit, y:\",\n \"supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self:\",\n \"not_(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for x in\",\n \"in zip(self, other)]) def __ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"bits, other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit())\",\n \"\\\"\\\"\\\" Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_())\",\n \"for representing an abstract bit. Such a bit can be interpreted concretely as\",\n \"& constant(1) >>> b.value 0 \\\"\\\"\\\" return self & (constant(other) if isinstance(other, int)\",\n \"bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for b in\",\n \"not currently in use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one\",\n \"out of those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>>\",\n \"bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1,\",\n \"value, but it is also used to keep track of relationships between operators\",\n \"def nif(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"bits([x.or_(y) for (x, y) in zip(self, other)]) def __or__(self: bits, other: bits) ->\",\n \"self, other) def __lt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"= outputs(xs.xor(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.imp_(ys)) ... ns = [int(z) for\",\n \"other)]) def or_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"None: return type(b1) else: return bit \\\"\\\"\\\" return bit @staticmethod def gate(operation, igs):\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self,\",\n \"bss = list(bs / {2}) >>> [[b.value for b in bs] for bs\",\n \"an output of type `bit` or `bits`. >>> @synthesize ... def equal(x: bit,\",\n \"integer 1 \\\"\\\"\\\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can only\",\n \"inputs([y, y, y])) ... zs = outputs(xs % ys) ... ns = [int(z)\",\n \"all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self:\",\n \"# Compute the value of the result of the operation on the arguments.\",\n \"operation on the arguments. v = o(*[a.value for a in args]) # Return\",\n \"return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self: bits, other: bits)\",\n \"doctest from parts import parts from circuit import op, gate, circuit, signature class\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b)\",\n \"y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in\",\n \">>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>> b.value 1 \\\"\\\"\\\" return\",\n \"[] >>> for (x, y) in [(0, 0), (0, 1), (1, 0), (1,\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs /\",\n \"bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"from __future__ import annotations from typing import Sequence import doctest from parts import\",\n \"\\\"\\\"\\\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a\",\n \"output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other)\",\n \"is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for representing an input or\",\n \"arguments and returns an output of type `bit` or `bits`. >>> @synthesize ...\",\n \"zs = outputs(xs ^ ys) ... ns = [int(z) for z in zs]\",\n \"zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"for b in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1],\",\n \">> {3} >>> [b.value for b in bs] [1, 1, 1, 0, 0,\",\n \"[1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for\",\n \"other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract a bit from\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"return bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"= outputs(xs > ys) ... ns = [int(z) for z in zs] ...\",\n \"for bs in bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \\\"\\\"\\\"\",\n \"b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation\",\n \"bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self, other):\",\n \"c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\"\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns\",\n \"\\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and\",\n \"bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k, a) in f.__annotations__.items() if k\",\n \"return type(b1) else: return bit \\\"\\\"\\\" return bit @staticmethod def gate(operation, igs): return\",\n \"except: raise RuntimeError('automated circuit synthesis failed') from None # Return the original function.\",\n \"[1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))\",\n \"(x, y) in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"self) def __rsub__(self, other): \\\"\\\"\\\" >>> results = [] >>> for x in\",\n \"^ (constant(other) if isinstance(other, int) else other) def or_(self, other): \\\"\\\"\\\" >>> results\",\n \"y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z) for z in zs]\",\n \"... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"def __init__(self: bit, b: bit): # Check if bit is ready as final\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z\",\n \"zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in zs] ... c\",\n \">>> b = 1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\" return self ^\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b)\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other)\",\n \"other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs\",\n \">>> bss = list(bs / {2}) >>> [[b.value for b in bs] for\",\n \"bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results\",\n \"other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1)\",\n \"bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"integer 1') def and_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2\",\n \"y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0],\",\n \"... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"and if # it returns an output. if bit._hook_operation is not None: r\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.if_(ys)) ...\",\n \"0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _\",\n \"`bit` or `bits`. >>> @synthesize ... def equal(x: bit, y: bit) -> bit:\",\n \">>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) ==\",\n \"= output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self,\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ...\",\n \"True >>> def make_hook(bit_): ... def hook(o, v, *args): ... return bit_.constructor(*args)(v, bit_.gate(o,\",\n \"is designated as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is designated as\",\n \"self, other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0 &\",\n \"bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None): # The inference\",\n \"y])) ... zs = outputs(xs % ys) ... ns = [int(z) for z\",\n \"in zip(self, other)]) def nand(self: bits, other) -> bits: \\\"\\\"\\\" >>> results =\",\n \"v, *args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0]\",\n \"inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns = [int(y) for y\",\n \"is designated as a variable input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value =\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\"\",\n \"operators and to represent the wires within a circuit built up out of\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\"\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z) for\",\n \"for (x, y) in zip(self, other)]) def xor_(self: bits, other: bits) -> bits:\",\n \"of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other)\",\n \"a # pylint: disable=W0123 try: # Construct the circuit and add it to\",\n \"zip(self, other)]) def or_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) %\",\n \"b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_,\",\n \"& y) | ((1 - x) & (1 - y)) >>> xys =\",\n \"b in bs] for bs in bss] [[1, 1], [1, 1], [0, 0],\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs <= ys) ... ns =\",\n \"output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other)\",\n \"a variable input.\\\"\\\"\\\" def __init__(self: bit, value: int): self.value = value self.gate =\",\n \"new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True) class bits_type(int): #\",\n \"a bit from the integer 1 \\\"\\\"\\\" if other == 1: return bit.operation(op.not_,\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >= input(y)) ... results.append(int(b)\",\n \"of the result of the operation on the arguments. v = o(*[a.value for\",\n \"types/signature from # the type annotation of the decorated function. type_in = lambda\",\n \"Return the original function. return f if __name__ == \\\"__main__\\\": doctest.testmod() # pragma:\",\n \"the integer 1') def and_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True >>> bit.circuit(circuit()) >>> 2 - input(0)\",\n \"zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"... return (x & y) | ((1 - x) & (1 - y))\",\n \"[conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1, 0], [1, 1]]\",\n \">>> b.value 0 \\\"\\\"\\\" return self & (constant(other) if isinstance(other, int) else other)\",\n \"(x, y) in zip(self, other)]) def or_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits, other: bits) ->\",\n \"bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x,\",\n \"return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value ==\",\n \">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1,\",\n \"... ys = outputs(~xs) ... ns = [int(y) for y in ys] ...\",\n \"second argument is a `bit`. args = list(args) if len(args) == 2: args[1]\",\n \"0] \\\"\\\"\\\" def __init__(self: bit, b: bit): # Check if bit is ready\",\n \"bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits, other: bits) ->\",\n \">>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0,\",\n \"an abstract bit. Such a bit can be interpreted concretely as a value,\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self,\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self, other):\",\n \"a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is designated an output. >>>\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ...\",\n \">>> b.value 1 \\\"\\\"\\\" return self | (constant(other) if isinstance(other, int) else other)\",\n \"... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"xy[0] & xy[1]) >>> xys = [bits([x, y]) for x in (0, 1)\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3\",\n \"xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>> @synthesize ... def\",\n \"other) def __matmul__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\" >>> results\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ...\",\n \"failed \\\"\\\"\\\" # Functions for determining types/signature from # the type annotation of\",\n \"parts import parts from circuit import op, gate, circuit, signature class bit(): \\\"\\\"\\\"\",\n \"bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"return bits([x.imp_(y) for (x, y) in zip(self, other)]) def nand(self: bits, other) ->\",\n \"other)]) def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation and shift\",\n \"outputs(~xs) ... ns = [int(y) for y in ys] ... c = bit.circuit()\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) ==\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y)\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def nif(self:\",\n \"bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y])) >>> all(results) True\",\n \"bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value for b in\",\n \"\\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other) ->\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"== bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\"\",\n \"nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"(constant(other) if isinstance(other, int) else other) def nor(self, other): \\\"\\\"\\\" >>> results =\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for\",\n \"1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1],\",\n \"in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1] >>> bit.circuit(circuit()) >>>\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def\",\n \"= outputs(xs | ys) ... ns = [int(z) for z in zs] ...\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self, other): \\\"\\\"\\\" >>>\",\n \"for xy in xys] [[0, 0], [0, 0], [1, 0], [1, 1]] >>>\",\n \"return bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits,\",\n \"(x, y) in zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None): self.value = value self.gate = bit._circuit.gate()\",\n \"0, 0, 1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"\\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y)))\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for\",\n \"*args: None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ...\",\n \"bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def\",\n \"def __matmul__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"self) def __invert__(self): \\\"\\\"\\\" >>> results = [] >>> for x in [0,\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y)))\",\n \"in zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_,\",\n \"recent call last): ... ValueError: can only subtract a bit from the integer\",\n \"z in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x,\",\n \"\\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"def operation(o, *args): # Ensure second argument is a `bit`. args = list(args)\",\n \"@ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self,\",\n \"xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\"\",\n \"True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)]) def nif_(self: bits,\",\n \"bits: \\\"\\\"\\\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs =\",\n \"can only subtract a bit from the integer 1 \\\"\\\"\\\" if other ==\",\n \"return bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"y) in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for representing an input or output type\",\n \"= outputs(xs.imp_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"else a # pylint: disable=W0123 try: # Construct the circuit and add it\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) ==\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y)\",\n \"int): return self / (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits,\",\n \"b = output(input(x) == input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"for (x, y) in zip(self, other)]) def xor(self: bits, other: bits) -> bits:\",\n \"y])) ... zs = outputs(xs <= ys) ... ns = [int(z) for z\",\n \"def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>>\",\n \"int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys =\",\n \"bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if r is not\",\n \"from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated as a variable input\",\n \"and returns an output of type `bit` or `bits`. >>> @synthesize ... def\",\n \"7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits)\",\n \">>> ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b)\",\n \"\\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs ^ ys)\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\" >>> results\",\n \"bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically\",\n \"Compute the value of the result of the operation on the arguments. v\",\n \"zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for x\",\n \"b in bs] [1, 1, 1, 0, 0, 0, 0, 1] \\\"\\\"\\\" if\",\n \"track of relationships between operators and to represent the wires within a circuit\",\n \"\\\"\\\"\\\" from __future__ import annotations from typing import Sequence import doctest from parts\",\n \"bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for\",\n \"vector of abstract bits. \\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return\",\n \"zip(self, other)]) def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation and\",\n \"input_two(input): \\\"\\\"\\\"Bit that is designated as a variable input from a second source.\\\"\\\"\\\"\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\" >>> results\",\n \"(x, y) in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"[0, 0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss\",\n \"... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"is designated as a variable input from one source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that\",\n \"1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results)\",\n \"... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"__int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0, 0, 0])\",\n \"bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0 \\\"\\\"\\\" return self\",\n \"return bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.imp(ys)) ... ns =\",\n \"y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in\",\n \"-> bits: \\\"\\\"\\\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>> bs\",\n \"if r is not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a\",\n \"output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other)\",\n \"in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0, 0,\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0 \\\"\\\"\\\"\",\n \"the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def\",\n \"the circuit and add it to the function as an attribute. bit.circuit(circuit()) args_in\",\n \"l)) def outputs(l): return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing\",\n \"y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in\",\n \"[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x,\",\n \"and len(other) == 1 and isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts\",\n \"0] \\\"\\\"\\\" return bits([ bit_ for byte_ in bytes_ for bit_ in bits.from_byte(byte_,\",\n \"decorated function. type_in = lambda a: input(0) if a is bit else inputs([0]\",\n \"of type `bit` or `bits`. >>> @synthesize ... def equal(x: bit, y: bit)\",\n \"it to a new wire. self.value = b.value self.gate = bit._circuit.gate(op.id_, [b.gate], is_output=True)\",\n \"hook if it exists and if # it returns an output. if bit._hook_operation\",\n \"= inputs([x, x, x]) ... ys = outputs(~xs) ... ns = [int(y) for\",\n \"bit): # Check if bit is ready as final output or whether there\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).or_(input(y))) ... results.append(int(b) ==\",\n \"-> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)])\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def\",\n \"return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self: bits) -> int:\",\n \"output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other)\",\n \"bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return\",\n \"[b.value for b in bs] [1, 0, 0, 0, 0, 0, 0, 0]\",\n \"[1, 0], [1, 1]] >>> @synthesize ... def equal(x, y): ... return x\",\n \"use. \\\"\\\"\\\" if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two)\",\n \"other)]) def if_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"input(0) if a is bit else inputs([0] * a) type_out = lambda a:\",\n \"... zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"== bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None):\",\n \"in args]) # Return output from hook if it exists and if #\",\n \"original function. return f if __name__ == \\\"__main__\\\": doctest.testmod() # pragma: no cover\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns = [int(z)\",\n \"... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"it. if len(b.gate.outputs) > 0: b = ~(~b) # Preserve the bit by\",\n \"= outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"other)]) def __and__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ...\",\n \"and shift operations. >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs =\",\n \"y) in zip(self, other)]) def __lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"= outputs(xs % ys) ... ns = [int(z) for z in zs] ...\",\n \"class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for representing an input or output\",\n \"bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other)\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\" >>> results\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z)\",\n \"for (x, y) in zip(self, other)]) def __or__(self: bits, other: bits) -> bits:\",\n \"constant(bit): \\\"\\\"\\\"Bit that is designated as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that\",\n \"bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod def constructor(b1, b2=None): # The\",\n \"self.gate = bit._circuit.gate(op.id_, is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated as a variable\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) >\",\n \"y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z) for z in\",\n \"\\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits, other:\",\n \"output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_,\",\n \"those definitions. \\\"\\\"\\\" from __future__ import annotations from typing import Sequence import doctest\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor(ys)) ... ns\",\n \"circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def nimp_(self, other):\",\n \"... def conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>>\",\n \"output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation = None\",\n \"if isinstance(b1, input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2,\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"\\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing a vector of abstract bits. \\\"\\\"\\\"\",\n \"\\\"\\\"\\\"Bit that is designated as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit that is\",\n \"[0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss\",\n \"... b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"\\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits, other:\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif_(input(y)))\",\n \"that is designated as a variable input from a second source.\\\"\\\"\\\" class output(bit):\",\n \"\\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits: \\\"\\\"\\\" Return bits\",\n \"zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self,\",\n \"__or__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"list(bs / [1, 3, 4]) >>> [[b.value for b in bs] for bs\",\n \"... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\" >>>\",\n \"def constructor(b1, b2=None): # The inference code below is not currently in use.\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) | input(y)) ... results.append(int(b)\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.or_(ys)) ... ns = [int(z)\",\n \"True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits,\",\n \"1) for y in (0, 1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0,\",\n \"from the integer 1') def and_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self,\",\n \"bit.circuit(circuit()) >>> 2 - input(0) Traceback (most recent call last): ... ValueError: can\",\n \"nif(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"return bits([x.nif_(y) for (x, y) in zip(self, other)]) def xor(self: bits, other: bits)\",\n \"_ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"def __gt__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self,\",\n \"bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>>\",\n \"zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \">>> for (x, y) in [(0, 0), (0, 1), (1, 0), (1, 1)]:\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x,\",\n \"def xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \">>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value\",\n \"def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit,\",\n \"circuit synthesis failed \\\"\\\"\\\" # Functions for determining types/signature from # the type\",\n \"[b.gate], is_output=True) class bits_type(int): # pylint: disable=R0903 \\\"\\\"\\\" Class for representing an input\",\n \"len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of\",\n \">>> [b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self: bit, b: bit):\",\n \"\\\"\\\"\\\" return self ^ (constant(other) if isinstance(other, int) else other) def or_(self, other):\",\n \"\\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"= output(input(x).imp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self,\",\n \"\\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]: ... bit.circuit(circuit())\",\n \"1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(~xs)\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y)\",\n \"y) in zip(self, other)]) def imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self:\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs >= ys) ... ns =\",\n \"bit, b: bit): # Check if bit is ready as final output or\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self,\",\n \"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y)\",\n \"... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True\",\n \"return bits([x.nimp_(y) for (x, y) in zip(self, other)]) def __gt__(self: bits, other: bits)\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns =\",\n \"def xnor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ...\",\n \"in zip(self, other)]) def xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"bit from the integer 1') def and_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"if isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self,\",\n \"if_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \">>> bss = list(bs / 2) >>> ([b.value for b in bss[0]], [b.value\",\n \"0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x, y): ... return\",\n \"abstract bit. Such a bit can be interpreted concretely as a value, but\",\n \"= output(b0) >>> [b0.value, b1.value, b2.value] [0, 1, 0] \\\"\\\"\\\" def __init__(self: bit,\",\n \"constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod def from_bytes(bytes_,\",\n \"in zip(self, other)]) def __or__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"other) def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0)\",\n \"True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits,\",\n \"bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ...\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys)) ... ns =\",\n \"__int__(self): return self.value def not_(self): \\\"\\\"\\\" >>> results = [] >>> for x\",\n \"b = 1 | constant(0) >>> b.value 1 \\\"\\\"\\\" return self | (constant(other)\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\" >>>\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self, other): \\\"\\\"\\\"\",\n \"bit can be interpreted concretely as a value, but it is also used\",\n \"bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs =\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self,\",\n \"None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ...\",\n \"def __rsub__(self, other): \\\"\\\"\\\" >>> results = [] >>> for x in [0,\",\n \"= output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self,\",\n \"is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1 =\",\n \"other) class constant(bit): \\\"\\\"\\\"Bit that is designated as a constant input.\\\"\\\"\\\" class input(bit):\",\n \"y in ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument =\",\n \"y, y])) ... zs = outputs(xs.xor_(ys)) ... ns = [int(z) for z in\",\n \"from the integer 1 \\\"\\\"\\\" if other == 1: return bit.operation(op.not_, self) raise\",\n \"\\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self,\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in\",\n \"outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ... c = bit.circuit()\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) ==\",\n \"return input_two elif isinstance(b1, (input_one, input_two)) and b2 is None: return type(b1) else:\",\n \"xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in ys]\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in\",\n \"ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ...\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) > input(y)) ... results.append(int(b)\",\n \"= output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self,\",\n \"return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ]) @staticmethod\",\n \"return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __ror__(self, other): \\\"\\\"\\\"\",\n \"... b = output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"@staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in\",\n \"return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits, other: bits)\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns\",\n \"eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try: # Construct the\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nif_(ys)) ... ns = [int(z) for\",\n \"isinstance(other, list) and len(other) > 0 and isinstance(other[0], int): return map(bits, parts(self, length=other))\",\n \"bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"0, 0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _ in\",\n \"in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"__truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0]))\",\n \"<< 3 >>> [b.value for b in bs] [1, 0, 0, 0, 0,\",\n \"lambda a: eval(a) if isinstance(a, str) else a # pylint: disable=W0123 try: #\",\n \"3 >>> [b.value for b in bs] [1, 0, 0, 0, 0, 0,\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y))\",\n \"from # the type annotation of the decorated function. type_in = lambda a:\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x)\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\"\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\"\",\n \"in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits:\",\n \"... zs = outputs(xs.and_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"\\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits, other:\",\n \"y, y])) ... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in\",\n \"b in bss[0]], [b.value for b in bss[1]]) ([1, 1, 1, 1], [0,\",\n \"bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns\",\n \">>> bss = list(bs / [1, 3, 4]) >>> [[b.value for b in\",\n \"other) def __or__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"def __ror__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 | constant(0) >>>\",\n \"\\\"\\\"\\\" @staticmethod def from_byte(byte_: int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_\",\n \"... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"return (xy[0], xy[0] & xy[1]) >>> xys = [bits([x, y]) for x in\",\n \"input_one) and isinstance(b2, input_one): return input_one elif isinstance(b1, input_two) and isinstance(b2, input_two): return\",\n \">>> b.value 1 \\\"\\\"\\\" return self ^ (constant(other) if isinstance(other, int) else other)\",\n \"\\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self, other): \\\"\\\"\\\" >>> results = []\",\n \"[0], [0], [1]] >>> @synthesize ... def conjunction(xy: bits(2)) -> bits(2): ... return\",\n \"if isinstance(other, int) else other) def or_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"(x, y) in zip(self, other)]) def nand_(self: bits, other) -> bits: \\\"\\\"\\\" >>>\",\n \"hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure second argument is\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y)\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs & ys) ...\",\n \"__le__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs == ys) ... ns\",\n \"it exists and if # it returns an output. if bit._hook_operation is not\",\n \"can be interpreted concretely as a value, but it is also used to\",\n \"= bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for b\",\n \"isinstance(argument, int) else\\\\ list.__new__(cls, argument) def __int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for\",\n \"assembling abstract definitions of logic circuits and synthesizing circuits from those definitions. \\\"\\\"\\\"\",\n \"not None: return r return bit.constructor(*args)(v, bit.gate(o, [a.gate for a in args])) @staticmethod\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self, other):\",\n \"return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) ->\",\n \"self.value = value self.gate = bit._circuit.gate() if gate_ is None else gate_ def\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def __ge__(self,\",\n \"lengths. elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return self\",\n \"of parts is `other`. def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of bit\",\n \"conjunction(xy: bits(2)) -> bits(2): ... return (xy[0], xy[0] & xy[1]) >>> xys =\",\n \"bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs >> 3 >>> [b.value for\",\n \"other) def xor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"input(bit): \\\"\\\"\\\"Bit that is designated as a variable input.\\\"\\\"\\\" def __init__(self: bit, value:\",\n \"1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))] [0,\",\n \"`other`. else: return map(bits, parts(self, other)) # Number of parts is `other`. def\",\n \"bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>>\",\n \"nif(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"self, other) def __and__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"all(results) True \\\"\\\"\\\" return bits([x.not_() for x in self]) def and_(self: bits, other:\",\n \"is not None: r = bit._hook_operation(o, v, *args) if r is not None:\",\n \"zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"self / (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self, other))\",\n \"True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other) def __gt__(self, other): \\\"\\\"\\\" >>> results =\",\n \"for assembling abstract definitions of logic circuits and synthesizing circuits from those definitions.\",\n \"input from a second source.\\\"\\\"\\\" class output(bit): \\\"\\\"\\\" Bit that is designated an\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs >= ys)\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self, other): \\\"\\\"\\\"\",\n \"bit.circuit(circuit()) ... b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def\",\n \"= bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value for y in ys] [1,\",\n \"y])) ... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs]\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def xor_(self, other):\",\n \"bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ...\",\n \"[(0, 0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... (xs, ys)\",\n \"bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"its arguments and returns an output of type `bit` or `bits`. >>> @synthesize\",\n \"zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"__lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"else other) def or_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"zs = outputs(xs & ys) ... ns = [int(z) for z in zs]\",\n \"the integer 1 \\\"\\\"\\\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self, other):\",\n \">>> bs = bs >> 3 >>> [b.value for b in bs] [0,\",\n \"other) def __le__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"but it is also used to keep track of relationships between operators and\",\n \"bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for b in\",\n \"other) def if_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\" >>> results =\",\n \"= value self.gate = bit._circuit.gate() if gate_ is None else gate_ def __int__(self):\",\n \"int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys =\",\n \"b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0, 1,\",\n \"def __lt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0]\",\n \"bit.operation(op.not_, self) raise ValueError('can only subtract a bit from the integer 1') def\",\n \"... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def __le__(self:\",\n \"for (x, y) in zip(self, other)]) def nor(self: bits, other: bits) -> bits:\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"= [bits([x, y]) for x in (0, 1) for y in (0, 1)]\",\n \"b = output(input(x) & input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"final output or whether there are others dependent on it. if len(b.gate.outputs) >\",\n \"in self]) def and_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i in range(8)]) ])\",\n \">>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ...\",\n \"y) in zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"= outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"\\\"\\\"\\\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_ is\",\n \"nif_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"[0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>>\",\n \"output(input(x) >= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_,\",\n \"nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self, other):\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)])\",\n \"True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def imp_(self: bits,\",\n \"in zip(self, other)]) def nor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"def __invert__(self): \\\"\\\"\\\" >>> results = [] >>> for x in [0, 1]:\",\n \"True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\" >>> results =\",\n \"True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def __mod__(self, other)\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"circuits. Embedded domain-specific combinator library for assembling abstract definitions of logic circuits and\",\n \"in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"return bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \">>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7\",\n \"b0 = output(input(1).not_()) >>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value,\",\n \"1, 1, 1, 1] >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([11, 0]))]\",\n \"output from hook if it exists and if # it returns an output.\",\n \"... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True\",\n \"class constant(bit): \\\"\\\"\\\"Bit that is designated as a constant input.\\\"\\\"\\\" class input(bit): \\\"\\\"\\\"Bit\",\n \"y) in zip(self, other)]) def nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"__or__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"< input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other) def\",\n \"other)]) def imp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"bits([x.and_(y) for (x, y) in zip(self, other)]) def __and__(self: bits, other: bits) ->\",\n \">>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs = bs >> {3} >>> [b.value\",\n \"\\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1]))\",\n \"outputs(xs & ys) ... ns = [int(z) for z in zs] ... c\",\n \"def zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>>\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns\",\n \"output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other)\",\n \"True \\\"\\\"\\\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if circuit_\",\n \"in bss] [[1], [1, 1, 1], [0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other,\",\n \"b = output(input(x).nif_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_,\",\n \"all(results) True \\\"\\\"\\\" return bits([x.if_(y) for (x, y) in zip(self, other)]) def __ge__(self:\",\n \"1]] >>> @synthesize ... def equal(x, y): ... return x & y Traceback\",\n \"synthesizing a circuit from a function that takes only `bit` and/or `bits` objects\",\n \"RuntimeError('automated circuit synthesis failed') from None # Return the original function. return f\",\n \"The inference code below is not currently in use. \\\"\\\"\\\" if isinstance(b1, input_one)\",\n \"= circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation =\",\n \"or output type of a function decorated for automated synthesis. \\\"\\\"\\\" class bits(list):\",\n \"for (x, y) in zip(self, other)]) def __gt__(self: bits, other: bits) -> bits:\",\n \"all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def if_(self:\",\n \"bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / [1, 3, 4]) >>>\",\n \"[1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n) def __new__(cls, argument = None) -> bits:\",\n \"1 \\\"\\\"\\\" return self ^ (constant(other) if isinstance(other, int) else other) def or_(self,\",\n \"... zs = outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"def equal(x, y): ... return x & y Traceback (most recent call last):\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def\",\n \"zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y,\",\n \"= outputs(~xs) ... ns = [int(y) for y in ys] ... c =\",\n \"bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" return self + other def constants(l): return bits(map(constant,\",\n \"zs = outputs(xs.or_(ys)) ... ns = [int(z) for z in zs] ... c\",\n \"[1,1,1,1,0,0,0,0])) >>> bs = bs << 3 >>> [b.value for b in bs]\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)]) def\",\n \"__rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b) ==\",\n \"for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(~input(x)) ... results.append(int(b)\",\n \"& ys) ... ns = [int(z) for z in zs] ... c =\",\n \"bit.operation(op.nand_, self, other) def nand_(self, other): \\\"\\\"\\\" >>> results = [] >>> for\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs <=\",\n \"\\\"\\\"\\\" return bit.operation(op.nor_, self, other) def nor_(self, other): \\\"\\\"\\\" >>> results = []\",\n \"and add it to the function as an attribute. bit.circuit(circuit()) args_in = {\",\n \"... zs = outputs(xs & ys) ... ns = [int(z) for z in\",\n \"y): ... return x & y Traceback (most recent call last): ... RuntimeError:\",\n \"whether there are others dependent on it. if len(b.gate.outputs) > 0: b =\",\n \"and_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from None # Return the original\",\n \"y, y])) ... zs = outputs(xs.xnor(ys)) ... ns = [int(z) for z in\",\n \"bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1,\",\n \"[1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for b in bs]\",\n \"l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output, l)) def synthesize(f):\",\n \"(x, y) in zip(self, other)]) def if_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b)\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\" >>> results\",\n \"bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits, other: bits)\",\n \">>> b1 = output(b0.not_()) >>> b2 = output(b0) >>> [b0.value, b1.value, b2.value] [0,\",\n \"y) in zip(self, other)]) def nif(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"= output(input(x).if_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self,\",\n \"(x, y) in zip(self, other)]) def xor(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y))) ... results.append(int(b)\",\n \">>> @synthesize ... def equal(x: bit, y: bit) -> bit: ... return (x\",\n \"call last): ... ValueError: can only subtract a bit from the integer 1\",\n \"x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y)\",\n \"return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits, other) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit())\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ... ns = [int(z)\",\n \"return bits([x.nor_(y) for (x, y) in zip(self, other)]) def xnor(self: bits, other: bits)\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self, other): \\\"\\\"\\\"\",\n \"other)]) def nif_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"function that takes only `bit` and/or `bits` objects as its arguments and returns\",\n \"= output(input(x).nand_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self,\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for\",\n \"bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"y, y])) ... zs = outputs(xs <= ys) ... ns = [int(z) for\",\n \"input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other)\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs % ys) ... ns =\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def\",\n \"output. if bit._hook_operation is not None: r = bit._hook_operation(o, v, *args) if r\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ...\",\n \"for (x, y) in zip(self, other)]) def nor_(self: bits, other: bits) -> bits:\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y,\",\n \"typing import Sequence import doctest from parts import parts from circuit import op,\",\n \"x in (0, 1) for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy\",\n \"hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value == bit.circuit().evaluate([0,0])[0]\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b)\",\n \"return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self, value, gate_=None):\",\n \"@staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3)\",\n \"... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"[int(z) for z in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x,\",\n \"is ready as final output or whether there are others dependent on it.\",\n \"return bit.operation(op.or_, self, other) def __or__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for z in\",\n \"= [] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b =\",\n \"== bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>>\",\n \">> 3 >>> [b.value for b in bs] [0, 0, 0, 1, 1,\",\n \"= output(input(x).nor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self,\",\n \"... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y, y, y]))\",\n \"= outputs(xs == ys) ... ns = [int(z) for z in zs] ...\",\n \"= list(bs / [1, 3, 4]) >>> [[b.value for b in bs] for\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xnor_(input(y))) ... results.append(int(b) ==\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>> [y.value\",\n \"bits([x.if_(y) for (x, y) in zip(self, other)]) def imp(self: bits, other: bits) ->\",\n \"bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\"\",\n \"Return bits object given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int)\",\n \"if isinstance(other, int) else other) def nimp(self, other): \\\"\\\"\\\" >>> results = []\",\n \"import Sequence import doctest from parts import parts from circuit import op, gate,\",\n \"\\\"\\\"\\\" return bits([x.not_() for x in self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\"\",\n \"= 1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\" return self ^ (constant(other) if\",\n \"other)]) def xor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"0 & constant(1) >>> b.value 0 \\\"\\\"\\\" return self & (constant(other) if isinstance(other,\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self, other):\",\n \"bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\" >>>\",\n \"return bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp(ys)) ... ns = [int(z)\",\n \"other)]) def nand(self: bits, other) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"\\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0, 0), (0,\",\n \"return self | (constant(other) if isinstance(other, int) else other) def nor(self, other): \\\"\\\"\\\"\",\n \"xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def __mod__(self,\",\n \"1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\"\",\n \"failed') from None # Return the original function. return f if __name__ ==\",\n \"@staticmethod def from_bytes(bytes_, constructor=bit) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b\",\n \"!= 'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed')\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self, other):\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for (x,\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) < input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"bit.circuit().evaluate([0,0])[0] True \\\"\\\"\\\" _circuit = None _hook_operation = None @staticmethod def circuit(circuit_=None): if\",\n \"outputs(xs < ys) ... ns = [int(z) for z in zs] ... c\",\n \"return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self: bits, other: bits)\",\n \"constructor(b1, b2=None): # The inference code below is not currently in use. \\\"\\\"\\\"\",\n \"[] >>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_())\",\n \"return self.nif(other) def xor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"Number of parts is `other`. def __add__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation of\",\n \"-> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs =\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"= [int(z) for z in zs] ... c = bit.circuit() ... results.append(ns ==\",\n \"def __ge__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"= (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.and_(ys)) ... ns\",\n \"... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True\",\n \"True \\\"\\\"\\\" return bit.operation(op.not_, self) def __rsub__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"bits(self[len(self)-quantity:]) ** bits(self[0:len(self)-quantity]) else: # Shift return bits([constant(0)]*other) ** bits(self[0:len(self)-other]) def __lshift__(self: bits,\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> [b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1,\",\n \"[0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys =\",\n \"other) -> bits: \\\"\\\"\\\"Concatenation of bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result)\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y)))\",\n \"other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]:\",\n \"other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>> b.value 0\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) == input(y)) ... results.append(int(b) ==\",\n \"bit \\\"\\\"\\\" return bit @staticmethod def gate(operation, igs): return bit._circuit.gate(operation, igs) def __init__(self,\",\n \"True \\\"\\\"\\\" return bits([x.nand_(y) for (x, y) in zip(self, other)]) def __rshift__(self: bits,\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def __lt__(self, other): \\\"\\\"\\\" >>>\",\n \">>> for x in [0, 1]: ... bit.circuit(circuit()) ... b = output(input(x).not_()) ...\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) <= input(y)) ... results.append(int(b)\",\n \"\\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0) for _ in range(other)]) def __truediv__(self: bits, other)\",\n \"= output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o,\",\n \"[b.value for b in bits.from_bytes(bytes([255]))] [1, 1, 1, 1, 1, 1, 1, 1]\",\n \"in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>>\",\n \"= outputs(xs.nor_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results)\",\n \"for (x, y) in zip(self, other)]) def nimp(self: bits, other: bits) -> bits:\",\n \"elif isinstance(other, set) and len(other) == 1 and isinstance(list(other)[0], int): return self /\",\n \"is_input=True) class input_one(input): \\\"\\\"\\\"Bit that is designated as a variable input from one\",\n \"y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z in zs]\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nand_(y) for (x,\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor_(input(y))) ... results.append(int(b) ==\",\n \"Ensure second argument is a `bit`. args = list(args) if len(args) == 2:\",\n \"bit._circuit @staticmethod def hook_operation(hook=None): bit._hook_operation = hook @staticmethod def operation(o, *args): # Ensure\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y)))\",\n \"len(args) == 2: args[1] = constant(args[1]) if isinstance(args[1], int) else args[1] # Compute\",\n \"other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation and shift operations. >>> bit.circuit(circuit()) >>>\",\n \">>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bs = bs << 3\",\n \"and b2 is None: return type(b1) else: return bit \\\"\\\"\\\" return bit @staticmethod\",\n \"def nor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"\\\"\\\"\\\" return bit.operation(op.and_, self, other) def __and__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"^ constant(0) >>> b.value 1 \\\"\\\"\\\" return self ^ (constant(other) if isinstance(other, int)\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\" >>>\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"int, constructor=bit) -> bits: return bits([ constructor(bit_) for bit_ in reversed([(byte_>>i)%2 for i\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) & input(y)) ... results.append(int(b)\",\n \"~(~b) # Preserve the bit by copying it to a new wire. self.value\",\n \"inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys)) ... ns = [int(z) for z\",\n \"(0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nif(input(y))) ...\",\n \"def __gt__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"+ other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z)\",\n \"... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs =\",\n \"def xor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"range(other)]) def __truediv__(self: bits, other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs =\",\n \"in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys\",\n \"1, 1], [0, 0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list) and len(other) >\",\n \"... xs = inputs([x, x, x]) ... ys = outputs(xs.not_()) ... ns =\",\n \"]) @staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs =\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) class constant(bit):\",\n \"0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0,\",\n \"value, gate_=None): self.value = value self.gate = bit._circuit.gate() if gate_ is None else\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b)\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\" >>> results =\",\n \"\\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def xor_(self: bits, other:\",\n \"[[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs =\",\n \"def nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>>\",\n \"# Ensure second argument is a `bit`. args = list(args) if len(args) ==\",\n \"= outputs(xs.not_()) ... ns = [int(y) for y in ys] ... c =\",\n \"y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in zip(self,\",\n \"# pylint: disable=W0123 try: # Construct the circuit and add it to the\",\n \"# The inference code below is not currently in use. \\\"\\\"\\\" if isinstance(b1,\",\n \"outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1] \\\"\\\"\\\" return bits([constant(0)]*n)\",\n \"within a circuit built up out of those operators. >>> bit.hook_operation(lambda o, v,\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) % input(y)) ... results.append(int(b) ==\",\n \"list.__new__(cls, argument) def __int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs =\",\n \"bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / {2}) >>> [[b.value for\",\n \"that is designated an output. >>> bit.circuit(circuit()) >>> b0 = output(input(1).not_()) >>> b1\",\n \"= output(input(x) <= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"bit_.gate(o, [a.gate for a in args])) ... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit())\",\n \"'return' } type_out(eval_(f.__annotations__['return']))(f(**args_in)) f.circuit = bit.circuit() except: raise RuntimeError('automated circuit synthesis failed') from\",\n \"bits object given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\\",\n \"bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits, other: bits) ->\",\n \"[1, 1]] >>> @synthesize ... def equal(x, y): ... return x & y\",\n \"Traceback (most recent call last): ... ValueError: can only subtract a bit from\",\n \"bit vectors.\\\"\\\"\\\" result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) ->\",\n \"\\\"\\\"\\\" return sum(int(b)*(2**i) for (i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) ->\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self, other): \\\"\\\"\\\" >>> results\",\n \"<= ys) ... ns = [int(z) for z in zs] ... c =\",\n \"None) >>> bit.circuit(circuit()) >>> b = output(input(1).and_(input(1))) >>> b.value == bit.circuit().evaluate([1,1])[0] True >>>\",\n \"= 0 & constant(1) >>> b.value 0 \\\"\\\"\\\" return self & (constant(other) if\",\n \"other)]) def nif(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"__ge__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"= [] >>> for (x, y) in [(0, 0), (0, 1), (1, 0),\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"\\\"\\\"\\\" return bit.operation(op.if_, self, other) def imp(self, other): \\\"\\\"\\\" >>> results = []\",\n \"return self & (constant(other) if isinstance(other, int) else other) def nimp(self, other): \\\"\\\"\\\"\",\n \"True \\\"\\\"\\\" return bit.operation(op.nif_, self, other) def nif_(self, other): \\\"\\\"\\\" >>> results =\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y)))\",\n \"0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation.\",\n \"decorated for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class for representing a vector\",\n \"(1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand_(input(y))) ... results.append(int(b) ==\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def imp_(self,\",\n \"1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp(input(y))) ... results.append(int(b)\",\n \"output(input(x).nimp(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nimp_, self, other)\",\n \"\\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\"\",\n \"Class for representing an input or output type of a function decorated for\",\n \"self]) def __invert__(self: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"other)]) def nor(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"b = output(input(x).xor(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_,\",\n \"def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 0 & constant(1) >>>\",\n \">= input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self,\",\n \"for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int) -> bits: \\\"\\\"\\\"\",\n \"zs = outputs(xs >= ys) ... ns = [int(z) for z in zs]\",\n \"y) in zip(self, other)]) def __le__(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \">>> b.value == bit.circuit().evaluate([1,1])[0] True >>> def make_hook(bit_): ... def hook(o, v, *args):\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)])\",\n \"byte_ in bytes_ for bit_ in bits.from_byte(byte_, constructor) ]) @staticmethod def zeros(n: int)\",\n \"return bits(map(output, l)) def synthesize(f): \\\"\\\"\\\" Decorator for automatically synthesizing a circuit from\",\n \"of the operation on the arguments. v = o(*[a.value for a in args])\",\n \"results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def __invert__(self): \\\"\\\"\\\"\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self, other):\",\n \"b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_,\",\n \"if isinstance(other, set) and isinstance(list(other)[0], int): # Rotation. quantity = list(other)[0] return bits(self[len(self)-quantity:])\",\n \"| (constant(other) if isinstance(other, int) else other) def nor(self, other): \\\"\\\"\\\" >>> results\",\n \"source.\\\"\\\"\\\" class input_two(input): \\\"\\\"\\\"Bit that is designated as a variable input from a\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nimp_(y) for (x, y) in\",\n \"1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>> bs\",\n \"and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif isinstance(other,\",\n \"1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>>\",\n \"True \\\"\\\"\\\" return bit.operation(op.and_, self, other) def __rand__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>>\",\n \"between operators and to represent the wires within a circuit built up out\",\n \"... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0], [0], [1]]\",\n \"x & y Traceback (most recent call last): ... RuntimeError: automated circuit synthesis\",\n \"[1, 1, 1, 0, 0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other, set) and\",\n \"args]) # Return output from hook if it exists and if # it\",\n \"all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def if_(self, other): \\\"\\\"\\\" >>> results\",\n \"bss] [[1, 1], [1, 1], [0, 0], [0, 0]] >>> bit.circuit(circuit()) >>> bs\",\n \"1)]: ... bit.circuit(circuit()) ... (xs, ys) = (inputs([x, x, x]), inputs([y, y, y]))\",\n \"return self + other def constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input,\",\n \"bit.circuit(circuit()) >>> b = 1 ^ constant(0) >>> b.value 1 \\\"\\\"\\\" return self\",\n \"object given the supplied argument. \\\"\\\"\\\" return bits_type(argument)\\\\ if isinstance(argument, int) else\\\\ list.__new__(cls,\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nor(input(y)))\",\n \"= outputs(xs.nimp_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b = 1 ^ constant(0)\",\n \"= bit.circuit() ... results.append(ns == c.evaluate([x, x, x])) >>> all(results) True \\\"\\\"\\\" return\",\n \"if circuit_ is not None: bit._circuit = circuit_ return None else: bit._circuit.prune_and_topological_sort_stable() return\",\n \"output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other)\",\n \">>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\" >>>\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nor_, self, other) def xnor(self,\",\n \"\\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __xor__(self, other): \\\"\\\"\\\" >>> results = []\",\n \"zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x) ^ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"y) in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xor(ys)) ...\",\n \"... zs = outputs(xs.imp(ys)) ... ns = [int(z) for z in zs] ...\",\n \"and_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"def xor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"\\\"\\\"\\\"Bit that is designated as a variable input from one source.\\\"\\\"\\\" class input_two(input):\",\n \"those operators. >>> bit.hook_operation(lambda o, v, *args: None) >>> bit.circuit(circuit()) >>> b =\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nif(other) def xor(self, other):\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.if_(y) for\",\n \"= output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.and_, self,\",\n \"xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"other) def or_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"parts(self, length=other)) # Sequence of lengths. elif isinstance(other, set) and len(other) == 1\",\n \"... return hook >>> bit.hook_operation(make_hook(bit)) >>> bit.circuit(circuit()) >>> b = output(input(0).and_(input(0))) >>> b.value\",\n \"the function as an attribute. bit.circuit(circuit()) args_in = { k: type_in(eval_(a)) for (k,\",\n \"= outputs(xs >= ys) ... ns = [int(z) for z in zs] ...\",\n \"... zs = outputs(xs.nand_(ys)) ... ns = [int(z) for z in zs] ...\",\n \"b2 is None: return type(b1) else: return bit \\\"\\\"\\\" return bit @staticmethod def\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.xnor_(y) for (x,\",\n \"__eq__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in [(0,\",\n \"y])) ... zs = outputs(xs >= ys) ... ns = [int(z) for z\",\n \"return bits([x.or_(y) for (x, y) in zip(self, other)]) def nor(self: bits, other: bits)\",\n \"3 >>> [b.value for b in bs] [0, 0, 0, 1, 1, 1,\",\n \"self, other) def xor_(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns = [int(z) for\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs\",\n \"representing an input or output type of a function decorated for automated synthesis.\",\n \"[0, 0], [1, 0], [1, 1]] >>> @synthesize ... def equal(x, y): ...\",\n \"output(~input(x)) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def\",\n \"(x, y) in zip(self, other)]) def __and__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.imp_, self, other) def nand(self,\",\n \"x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x,\",\n \"result = list(self) result.extend(list(other)) return bits(result) def __pow__(self: bits, other) -> bits: \\\"\\\"\\\"Concatenation\",\n \"for automatically synthesizing a circuit from a function that takes only `bit` and/or\",\n \"... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.if_, self, other) def\",\n \"for y in (0, 1)] >>> [equal.circuit.evaluate(xy) for xy in xys] [[1], [0],\",\n \"True \\\"\\\"\\\" return bits([x.and_(y) for (x, y) in zip(self, other)]) def nimp(self: bits,\",\n \">>> all(results) True \\\"\\\"\\\" return bits([x.or_(y) for (x, y) in zip(self, other)]) def\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.or_, self, other) def __or__(self,\",\n \"(x, y) in zip(self, other)]) def nimp_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \">>> b = 0 & constant(1) >>> b.value 0 \\\"\\\"\\\" return self &\",\n \"bits: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = bits.zeros(3) >>> ys = outputs(xs.not_()) >>>\",\n \"elif isinstance(b1, input_two) and isinstance(b2, input_two): return input_two elif isinstance(b1, (input_one, input_two)) and\",\n \"[int(y) for y in ys] ... c = bit.circuit() ... results.append(ns == c.evaluate([x,\",\n \"bs] [1, 1, 1, 0, 0, 0, 0, 1] \\\"\\\"\\\" if isinstance(other, set)\",\n \"bit.circuit(circuit()) >>> xs = constants([0, 0, 0]) >>> ys = outputs(xs.not_()) >>> int(ys)\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs.nor_(ys)) ... ns = [int(z)\",\n \"None) -> bits: \\\"\\\"\\\" Return bits object given the supplied argument. \\\"\\\"\\\" return\",\n \"... bit.circuit(circuit()) ... b = output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True\",\n \"bs] [0, 0, 0, 1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs\",\n \"return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"(x, y) in zip(self, other)]) def nor_(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"x, x]), inputs([y, y, y])) ... zs = outputs(xs > ys) ... ns\",\n \"input(0) Traceback (most recent call last): ... ValueError: can only subtract a bit\",\n \"b = output(input(x) > input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"output(input(x).not_()) ... results.append(int(b) == bit.circuit().evaluate([x])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.not_, self) def\",\n \"[b.value for b in bits.from_bytes(bytes([11, 0]))] [0, 0, 0, 0, 1, 0, 1,\",\n \"zip(self, other)]) def xnor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results =\",\n \"0, 0, 0]) >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss =\",\n \"value of the result of the operation on the arguments. v = o(*[a.value\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.imp_(y) for (x, y) in zip(self, other)])\",\n \"return bit.operation(op.nand_, self, other) def __matmul__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in zip(self, other)]) def nor_(self:\",\n \"isinstance(list(other)[0], int): return self / (len(self)//list(other)[0]) # Parts of length `other`. else: return\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nor(ys)) ... ns = [int(z) for z\",\n \"constants(l): return bits(map(constant, l)) def inputs(l): return bits(map(input, l)) def outputs(l): return bits(map(output,\",\n \"a) type_out = lambda a: output if a is bit else outputs #\",\n \"return bit.operation(op.imp_, self, other) def __le__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nif_(y) for (x, y) in zip(self, other)])\",\n \"or_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = [] >>> for\",\n \"outputs(xs % ys) ... ns = [int(z) for z in zs] ... c\",\n \"bit.circuit(circuit()) ... b = output(input(x).and_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\"\",\n \"\\\"\\\"\\\" return bit.operation(op.xor_, self, other) def __rxor__(self, other): \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> b\",\n \"1 \\\"\\\"\\\" if other == 1: return bit.operation(op.not_, self) raise ValueError('can only subtract\",\n \"argument) def __int__(self: bits) -> int: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> xs = constants([0,\",\n \"= outputs(xs.xor_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"(constant(other) if isinstance(other, int) else other) def nimp(self, other): \\\"\\\"\\\" >>> results =\",\n \"for x in [0, 1]: ... bit.circuit(circuit()) ... xs = inputs([x, x, x])\",\n \"(x, y) in zip(self, other)]) def __xor__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"def __mod__(self, other) -> bits: \\\"\\\"\\\" >>> results = [] >>> for (x,\",\n \"def __rshift__(self: bits, other) -> bits: \\\"\\\"\\\" Overloaded operator: rotation and shift operations.\",\n \"[1, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits(self[other:]) ** bits([constant(0)\",\n \"ys = outputs(xs.not_()) >>> [y.value for y in ys] [1, 1, 1] \\\"\\\"\\\"\",\n \"for (x, y) in zip(self, other)]) def if_(self: bits, other: bits) -> bits:\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).if_(input(y)))\",\n \"of relationships between operators and to represent the wires within a circuit built\",\n \"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).xor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0])\",\n \"== bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return self.nimp(other) def nif(self, other): \\\"\\\"\\\" >>>\",\n \"other) -> Sequence[bits]: \\\"\\\"\\\" >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss\",\n \"other)]) def xor_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"= output(input(x) | input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"... ValueError: can only subtract a bit from the integer 1 \\\"\\\"\\\" if\",\n \"0), (0, 1), (1, 0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).nimp_(input(y)))\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def xnor_(self,\",\n \"the operation on the arguments. v = o(*[a.value for a in args]) #\",\n \"(x, y) in zip(self, other)]) def __eq__(self: bits, other: bits) -> bits: \\\"\\\"\\\"\",\n \"[0, 0]] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs\",\n \"it is also used to keep track of relationships between operators and to\",\n \"(1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x).imp_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"= outputs(xs.if_(ys)) ... ns = [int(z) for z in zs] ... c =\",\n \"y, y])) ... zs = outputs(xs >= ys) ... ns = [int(z) for\",\n \"True \\\"\\\"\\\" return bits([x.xnor_(y) for (x, y) in zip(self, other)]) def __eq__(self: bits,\",\n \"in bs] for bs in bss] [[1], [1, 1, 1], [0, 0, 0,\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.xnor_(ys))\",\n \"0, 0, 0]] \\\"\\\"\\\" if isinstance(other, list) and len(other) > 0 and isinstance(other[0],\",\n \"type of a function decorated for automated synthesis. \\\"\\\"\\\" class bits(list): \\\"\\\"\\\" Class\",\n \"return bit.operation(op.xnor_, self, other) def __eq__(self, other): \\\"\\\"\\\" >>> results = [] >>>\",\n \"other)]) def nimp(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>> results = []\",\n \"(xs, ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nimp_(ys))\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.xnor_, self, other) def __eq__(self,\",\n \"a in args])) @staticmethod def constructor(b1, b2=None): # The inference code below is\",\n \"c.evaluate([x, x, x, y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.and_(y) for\",\n \"0 and isinstance(other[0], int): return map(bits, parts(self, length=other)) # Sequence of lengths. elif\",\n \"... def equal(x: bit, y: bit) -> bit: ... return (x & y)\",\n \"bs << 3 >>> [b.value for b in bs] [1, 0, 0, 0,\",\n \"for (x, y) in zip(self, other)]) def xnor_(self: bits, other: bits) -> bits:\",\n \"takes only `bit` and/or `bits` objects as its arguments and returns an output\",\n \"other) def nor(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"return self ^ (constant(other) if isinstance(other, int) else other) def or_(self, other): \\\"\\\"\\\"\",\n \"all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def __xor__(self:\",\n \"y, y, y])) >>> all(results) True \\\"\\\"\\\" return bits([x.nor_(y) for (x, y) in\",\n \"... b = output(input(x).nor_(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return\",\n \"ValueError('can only subtract a bit from the integer 1') def and_(self, other): \\\"\\\"\\\"\",\n \"... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>>\",\n \"in bss[1]]) ([1, 1, 1, 1], [0, 0, 0, 0]) >>> bit.circuit(circuit()) >>>\",\n \"in zs] ... c = bit.circuit() ... results.append(ns == c.evaluate([x, x, x, y,\",\n \"output(bit): \\\"\\\"\\\" Bit that is designated an output. >>> bit.circuit(circuit()) >>> b0 =\",\n \"all(results) True \\\"\\\"\\\" return bits([x.xor_(y) for (x, y) in zip(self, other)]) def or_(self:\",\n \"y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z in zs]\",\n \"1, 1, 1, 1, 0] >>> bit.circuit(circuit()) >>> bs = bits(map(bit, [0,0,0,0,1,1,1,1])) >>>\",\n \"other) def __ge__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y)\",\n \"[0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0,\",\n \"return self / (len(self)//list(other)[0]) # Parts of length `other`. else: return map(bits, parts(self,\",\n \"a: input(0) if a is bit else inputs([0] * a) type_out = lambda\",\n \"bs = bits(map(bit, [1,1,1,1,0,0,0,0])) >>> bss = list(bs / 2) >>> ([b.value for\",\n \"\\\"\\\"\\\" return bits([x.not_() for x in self]) def and_(self: bits, other: bits) ->\",\n \">>> ([b.value for b in bss[0]], [b.value for b in bss[1]]) ([1, 1,\",\n \"results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results) True \\\"\\\"\\\" return bit.operation(op.nand_, self, other) def __matmul__(self,\",\n \"ys) = (inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ...\",\n \"# the type annotation of the decorated function. type_in = lambda a: input(0)\",\n \"... bit.circuit(circuit()) ... xs = inputs([x, x, x]) ... ys = outputs(~xs) ...\",\n \"inputs([y, y, y])) ... zs = outputs(xs.nand(ys)) ... ns = [int(z) for z\",\n \"bits([x.xnor_(y) for (x, y) in zip(self, other)]) def xnor_(self: bits, other: bits) ->\",\n \"0]) >>> ys = outputs(xs.not_()) >>> int(ys) 7 \\\"\\\"\\\" return sum(int(b)*(2**i) for (i,\",\n \"(inputs([x, x, x]), inputs([y, y, y])) ... zs = outputs(xs.nif(ys)) ... ns =\",\n \"1)]: ... bit.circuit(circuit()) ... b = output(input(x).nand(input(y))) ... results.append(int(b) == bit.circuit().evaluate([x,y])[0]) >>> all(results)\",\n \"(i, b) in zip(range(len(self)), reversed(self))) def not_(self: bits) -> bits: \\\"\\\"\\\" >>> results\",\n \"1, 1, 0, 0, 0, 0, 0, 0, 0, 0] \\\"\\\"\\\" return bits([\",\n \"def __and__(self, other): \\\"\\\"\\\" >>> results = [] >>> for (x, y) in\",\n \"for x in self]) def and_(self: bits, other: bits) -> bits: \\\"\\\"\\\" >>>\",\n \"objects as its arguments and returns an output of type `bit` or `bits`.\",\n \"from None # Return the original function. return f if __name__ == \\\"__main__\\\":\",\n \"0]))] [0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0,\",\n \"is a `bit`. args = list(args) if len(args) == 2: args[1] = constant(args[1])\",\n \"1)] >>> [conjunction.circuit.evaluate(xy) for xy in xys] [[0, 0], [0, 0], [1, 0],\",\n \"0], [1, 1]] >>> @synthesize ... def equal(x, y): ... return x &\"\n]","isConversational":false}}},{"rowIdx":277,"cells":{"ngram":{"kind":"list like","value":["author = df['author'].to_list() message_counter = {} for i in author: if i in","# for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord =","graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o',","def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter","by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await ctx.send(file =","line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker =","= list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent","pandas as pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx):","import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df =","+= 1 else: message_counter[i] = 1 # for not mentioning the bot in","author: if i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 #","authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg","not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages","no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author')","import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author","sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await ctx.send(file","{} for i in author: if i in message_counter: message_counter[i] += 1 else:","pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df","plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape')","list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in the","as pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight')","plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for","import discord import random from datetime import datetime import pandas as pd import","df['author'].to_list() message_counter = {} for i in author: if i in message_counter: message_counter[i]","in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for not mentioning","mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages =","the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker","list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by","discord import random from datetime import datetime import pandas as pd import matplotlib.pyplot","i in author: if i in message_counter: message_counter[i] += 1 else: message_counter[i] =","plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in the server.')","matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv',","= 'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png')","'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout()","= pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i in","csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author =","'unicode_escape') author = df['author'].to_list() message_counter = {} for i in author: if i","else: message_counter[i] = 1 # for not mentioning the bot in the line","as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding=","author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await ctx.send(file = discord.File('output2.png'))","in author: if i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1","async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list()","= 1 # for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test')","import pandas as pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client,","message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10)","plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter =","bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord,","message_counter = {} for i in author: if i in message_counter: message_counter[i] +=","from datetime import datetime import pandas as pd import matplotlib.pyplot as plt import","plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await","import random from datetime import datetime import pandas as pd import matplotlib.pyplot as","= df['author'].to_list() message_counter = {} for i in author: if i in message_counter:","message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for not mentioning the","pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i in author:","if i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for","random from datetime import datetime import pandas as pd import matplotlib.pyplot as plt","for i in author: if i in message_counter: message_counter[i] += 1 else: message_counter[i]","1 # for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord","marker = 'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count')","message_counter[i] += 1 else: message_counter[i] = 1 # for not mentioning the bot","1 else: message_counter[i] = 1 # for not mentioning the bot in the","no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author","datetime import pandas as pd import matplotlib.pyplot as plt import csv async def","= {} for i in author: if i in message_counter: message_counter[i] += 1","the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values())","markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close()","in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages,","df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i","i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for not","encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i in author: if","ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {}","import datetime import pandas as pd import matplotlib.pyplot as plt import csv async","for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys())","message_counter[i] = 1 # for not mentioning the bot in the line graph.","datetime import datetime import pandas as pd import matplotlib.pyplot as plt import csv","= list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in"],"string":"[\n \"author = df['author'].to_list() message_counter = {} for i in author: if i in\",\n \"# for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord =\",\n \"graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o',\",\n \"def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter\",\n \"by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await ctx.send(file =\",\n \"line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker =\",\n \"= list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent\",\n \"pandas as pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx):\",\n \"import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df =\",\n \"+= 1 else: message_counter[i] = 1 # for not mentioning the bot in\",\n \"author: if i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 #\",\n \"authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg\",\n \"not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages\",\n \"no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author')\",\n \"import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author\",\n \"sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await ctx.send(file\",\n \"{} for i in author: if i in message_counter: message_counter[i] += 1 else:\",\n \"pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df\",\n \"plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape')\",\n \"list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in the\",\n \"as pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight')\",\n \"plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for\",\n \"import discord import random from datetime import datetime import pandas as pd import\",\n \"df['author'].to_list() message_counter = {} for i in author: if i in message_counter: message_counter[i]\",\n \"in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for not mentioning\",\n \"mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages =\",\n \"the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker\",\n \"list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by\",\n \"discord import random from datetime import datetime import pandas as pd import matplotlib.pyplot\",\n \"i in author: if i in message_counter: message_counter[i] += 1 else: message_counter[i] =\",\n \"plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in the server.')\",\n \"matplotlib.pyplot as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv',\",\n \"= 'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png')\",\n \"'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout()\",\n \"= pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i in\",\n \"csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author =\",\n \"'unicode_escape') author = df['author'].to_list() message_counter = {} for i in author: if i\",\n \"else: message_counter[i] = 1 # for not mentioning the bot in the line\",\n \"as plt import csv async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding=\",\n \"author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await ctx.send(file = discord.File('output2.png'))\",\n \"in author: if i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1\",\n \"async def plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list()\",\n \"= 1 # for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test')\",\n \"import pandas as pd import matplotlib.pyplot as plt import csv async def plot_user_activity(client,\",\n \"message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10)\",\n \"plot_user_activity(client, ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter =\",\n \"bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord,\",\n \"message_counter = {} for i in author: if i in message_counter: message_counter[i] +=\",\n \"from datetime import datetime import pandas as pd import matplotlib.pyplot as plt import\",\n \"plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close() await\",\n \"import random from datetime import datetime import pandas as pd import matplotlib.pyplot as\",\n \"= df['author'].to_list() message_counter = {} for i in author: if i in message_counter:\",\n \"message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for not mentioning the\",\n \"pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i in author:\",\n \"if i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for\",\n \"random from datetime import datetime import pandas as pd import matplotlib.pyplot as plt\",\n \"for i in author: if i in message_counter: message_counter[i] += 1 else: message_counter[i]\",\n \"1 # for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord\",\n \"marker = 'o', markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count')\",\n \"message_counter[i] += 1 else: message_counter[i] = 1 # for not mentioning the bot\",\n \"1 else: message_counter[i] = 1 # for not mentioning the bot in the\",\n \"no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author\",\n \"datetime import pandas as pd import matplotlib.pyplot as plt import csv async def\",\n \"= {} for i in author: if i in message_counter: message_counter[i] += 1\",\n \"the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values())\",\n \"markersize=10) plt.title('msg sent by author in the server.') plt.xlabel('Author') plt.ylabel('Message_count') plt.savefig('output2.png') plt.tight_layout() plt.close()\",\n \"in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages,\",\n \"df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i\",\n \"i in message_counter: message_counter[i] += 1 else: message_counter[i] = 1 # for not\",\n \"encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {} for i in author: if\",\n \"ctx): plt.style.use('fivethirtyeight') df = pd.read_csv('innovators.csv', encoding= 'unicode_escape') author = df['author'].to_list() message_counter = {}\",\n \"import datetime import pandas as pd import matplotlib.pyplot as plt import csv async\",\n \"for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys())\",\n \"message_counter[i] = 1 # for not mentioning the bot in the line graph.\",\n \"datetime import datetime import pandas as pd import matplotlib.pyplot as plt import csv\",\n \"= list(message_counter.values()) plt.plot(authors_in_discord, no_of_messages, marker = 'o', markersize=10) plt.title('msg sent by author in\"\n]","isConversational":false}}},{"rowIdx":278,"cells":{"ngram":{"kind":"list like","value":["#!/usr/bin/env python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read()","\"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic :: Scientific/Engineering :: Artificial Intelligence\"], )","node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec","long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]},","long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec =","author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\",","import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\",","\"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic :: Scientific/Engineering ::","version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\",","open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"),","<reponame>skojaku/fastnode2vec<gh_stars>10-100 #!/usr/bin/env python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__),","setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast","setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\",","fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\",","python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup(","packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic ::","os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\",","description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"],","\"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic :: Scientific/Engineering :: Artificial","def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation","from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\",","author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\",","install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic :: Scientific/Engineering","license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\",","url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic","read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of","import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\",","setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\",","name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"],","implementation of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\",","of node2vec\", long_description=read(\"README.md\"), long_description_content_type=\"text/markdown\", url=\"https://github.com/louisabraham/fastnode2vec\", packages=[\"fastnode2vec\"], install_requires=[\"numpy\", \"numba\", \"gensim\", \"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\":","return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\"fastnode2vec\", version=\"0.0.5\", author=\"<NAME>\", license=\"MIT\", author_email=\"<EMAIL>\", description=\"Fast implementation of node2vec\",","\"click\", \"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic :: Scientific/Engineering :: Artificial Intelligence\"],"],"string":"[\n \"#!/usr/bin/env python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read()\",\n \"\\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic :: Scientific/Engineering :: Artificial Intelligence\\\"], )\",\n \"node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec\",\n \"long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]},\",\n \"long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec =\",\n \"author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\",\",\n \"import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\",\",\n \"\\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic :: Scientific/Engineering ::\",\n \"version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\",\",\n \"open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"),\",\n \"<reponame>skojaku/fastnode2vec<gh_stars>10-100 #!/usr/bin/env python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__),\",\n \"setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast\",\n \"setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\",\",\n \"fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\",\",\n \"python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup(\",\n \"packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic ::\",\n \"os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\",\",\n \"description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"],\",\n \"\\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic :: Scientific/Engineering :: Artificial\",\n \"def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation\",\n \"from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\",\",\n \"author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\",\",\n \"install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic :: Scientific/Engineering\",\n \"license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\",\",\n \"url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic\",\n \"read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of\",\n \"import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\",\",\n \"setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\",\",\n \"name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"],\",\n \"implementation of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\",\",\n \"of node2vec\\\", long_description=read(\\\"README.md\\\"), long_description_content_type=\\\"text/markdown\\\", url=\\\"https://github.com/louisabraham/fastnode2vec\\\", packages=[\\\"fastnode2vec\\\"], install_requires=[\\\"numpy\\\", \\\"numba\\\", \\\"gensim\\\", \\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\":\",\n \"return open(os.path.join(os.path.dirname(__file__), fname)).read() setup( name=\\\"fastnode2vec\\\", version=\\\"0.0.5\\\", author=\\\"<NAME>\\\", license=\\\"MIT\\\", author_email=\\\"<EMAIL>\\\", description=\\\"Fast implementation of node2vec\\\",\",\n \"\\\"click\\\", \\\"tqdm\\\"], python_requires=\\\">=3.6\\\", entry_points={\\\"console_scripts\\\": [\\\"fastnode2vec = fastnode2vec.cli:node2vec\\\"]}, classifiers=[\\\"Topic :: Scientific/Engineering :: Artificial Intelligence\\\"],\"\n]","isConversational":false}}},{"rowIdx":279,"cells":{"ngram":{"kind":"list like","value":["os basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False","True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False","= False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig","= os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI =","PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name =","TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS","DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir,","= 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True","SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class","TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db')","DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION","SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI =","False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig,","+ os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING =","class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS =","os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING = True","'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name","= False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///'","'') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' +","'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING","= True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config):","SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI","Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True","= True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION =","= False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name = dict(","DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig ) key = Config.SECRET_KEY","False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig )","True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG","False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS","= os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config):","DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False","import os basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG =","class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir,","os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG","os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False","class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG =","DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class","= False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db')","= True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS =","ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig ) key =","SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig,","SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG =","os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///'","False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' +","'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI","= 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config):","+ os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG =","class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig ) key","basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class","'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG","True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False"],"string":"[\n \"os basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False\",\n \"True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False\",\n \"= False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig\",\n \"= os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI =\",\n \"PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name =\",\n \"TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS\",\n \"DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir,\",\n \"= 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True\",\n \"SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class\",\n \"TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db')\",\n \"DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION\",\n \"SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI =\",\n \"False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig,\",\n \"+ os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING =\",\n \"class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS =\",\n \"os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING = True\",\n \"'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name\",\n \"= False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///'\",\n \"'') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' +\",\n \"'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING\",\n \"= True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config):\",\n \"SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI\",\n \"Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True\",\n \"= True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION =\",\n \"= False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name = dict(\",\n \"DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig ) key = Config.SECRET_KEY\",\n \"False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig )\",\n \"True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG\",\n \"False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS\",\n \"= os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config):\",\n \"DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False\",\n \"import os basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG =\",\n \"class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir,\",\n \"os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG\",\n \"os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False\",\n \"class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG =\",\n \"DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class\",\n \"= False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db')\",\n \"= True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS =\",\n \"ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig ) key =\",\n \"SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig,\",\n \"SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG =\",\n \"os.getenv('SECRET_KEY', '') DEBUG = False class DevelopmentConfig(Config): DEBUG = True SQLALCHEMY_DATABASE_URI = 'sqlite:///'\",\n \"False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' +\",\n \"'flask_main.db') SQLALCHEMY_TRACK_MODIFICATIONS = False class TestingConfig(Config): DEBUG = True TESTING = True SQLALCHEMY_DATABASE_URI\",\n \"= 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config):\",\n \"+ os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG =\",\n \"class ProductionConfig(Config): DEBUG = False config_by_name = dict( dev=DevelopmentConfig, test=TestingConfig, prod=ProductionConfig ) key\",\n \"basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False class\",\n \"'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False class ProductionConfig(Config): DEBUG\",\n \"True TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False\"\n]","isConversational":false}}},{"rowIdx":280,"cells":{"ngram":{"kind":"list like","value":["exists' % self.user except KeyError: success = False ret_msg = 'User %s does","True ret_msg = 'User %s exists' % self.user except KeyError: success = False","chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if","= dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success, ret_msg =","self.user except KeyError: success = False ret_msg = 'User %s does not exists'","ret_msg = 'User %s exists' % self.user except KeyError: success = False ret_msg","self.user return success, ret_msg def main(): # Parsing argument file module = AnsibleModule(","ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user = user # Check","exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User","<reponame>djouani/Learning-Ansible-2.X-Third-Edition #!/usr/bin/env python import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self,","check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists'","self.user = user # Check if user exists def check_if_user_exists(self): try: user =","python import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user","= module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and","Parsing argument file module = AnsibleModule( argument_spec = dict( user = dict(required=True) )","class User: def __init__(self, user): self.user = user # Check if user exists","user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg =","user = dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success, ret_msg","success = True ret_msg = 'User %s exists' % self.user except KeyError: success","= dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr = User(user)","from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user = user #","success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg)","User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if success:","= pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' % self.user except","chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return","user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling","dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success,","Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__ ==","= user # Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user)","User: def __init__(self, user): self.user = user # Check if user exists def","pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' % self.user except KeyError:","# Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success =","argument file module = AnsibleModule( argument_spec = dict( user = dict(required=True) ) )","def main(): # Parsing argument file module = AnsibleModule( argument_spec = dict( user","ret_msg = 'User %s does not exists' % self.user return success, ret_msg def","ret_msg def main(): # Parsing argument file module = AnsibleModule( argument_spec = dict(","def __init__(self, user): self.user = user # Check if user exists def check_if_user_exists(self):","return success, ret_msg def main(): # Parsing argument file module = AnsibleModule( argument_spec","KeyError: success = False ret_msg = 'User %s does not exists' % self.user","module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON","import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user =","if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg","__init__(self, user): self.user = user # Check if user exists def check_if_user_exists(self): try:","= chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg)","Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True","not exists' % self.user return success, ret_msg def main(): # Parsing argument file","% self.user return success, ret_msg def main(): # Parsing argument file module =","argument_spec = dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr =","user): self.user = user # Check if user exists def check_if_user_exists(self): try: user",") user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error","% self.user except KeyError: success = False ret_msg = 'User %s does not","does not exists' % self.user return success, ret_msg def main(): # Parsing argument","dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists()","except KeyError: success = False ret_msg = 'User %s does not exists' %","try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' %","import AnsibleModule class User: def __init__(self, user): self.user = user # Check if","user # Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success","#!/usr/bin/env python import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user):","user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' % self.user","False ret_msg = 'User %s does not exists' % self.user return success, ret_msg","module = AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user =","file module = AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user","def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s","# Parsing argument file module = AnsibleModule( argument_spec = dict( user = dict(required=True)","= 'User %s exists' % self.user except KeyError: success = False ret_msg =","= True ret_msg = 'User %s exists' % self.user except KeyError: success =","'User %s does not exists' % self.user return success, ret_msg def main(): #","= User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if","%s exists' % self.user except KeyError: success = False ret_msg = 'User %s","success, ret_msg def main(): # Parsing argument file module = AnsibleModule( argument_spec =",") ) user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() #","pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user = user","AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr","%s does not exists' % self.user return success, ret_msg def main(): # Parsing","success = False ret_msg = 'User %s does not exists' % self.user return","= 'User %s does not exists' % self.user return success, ret_msg def main():","'User %s exists' % self.user except KeyError: success = False ret_msg = 'User","main(): # Parsing argument file module = AnsibleModule( argument_spec = dict( user =","handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__ == \"__main__\":","= AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user = module.params.get('user')","# Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__","ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else:","and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__ == \"__main__\": main()","AnsibleModule class User: def __init__(self, user): self.user = user # Check if user","exists' % self.user return success, ret_msg def main(): # Parsing argument file module","= False ret_msg = 'User %s does not exists' % self.user return success,"],"string":"[\n \"exists' % self.user except KeyError: success = False ret_msg = 'User %s does\",\n \"True ret_msg = 'User %s exists' % self.user except KeyError: success = False\",\n \"chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if\",\n \"= dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success, ret_msg =\",\n \"self.user except KeyError: success = False ret_msg = 'User %s does not exists'\",\n \"ret_msg = 'User %s exists' % self.user except KeyError: success = False ret_msg\",\n \"self.user return success, ret_msg def main(): # Parsing argument file module = AnsibleModule(\",\n \"ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user = user # Check\",\n \"exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User\",\n \"<reponame>djouani/Learning-Ansible-2.X-Third-Edition #!/usr/bin/env python import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self,\",\n \"check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists'\",\n \"self.user = user # Check if user exists def check_if_user_exists(self): try: user =\",\n \"python import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user\",\n \"= module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and\",\n \"Parsing argument file module = AnsibleModule( argument_spec = dict( user = dict(required=True) )\",\n \"class User: def __init__(self, user): self.user = user # Check if user exists\",\n \"user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg =\",\n \"user = dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success, ret_msg\",\n \"success = True ret_msg = 'User %s exists' % self.user except KeyError: success\",\n \"= dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr = User(user)\",\n \"from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user = user #\",\n \"success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg)\",\n \"User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if success:\",\n \"= pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' % self.user except\",\n \"chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return\",\n \"user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling\",\n \"dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success,\",\n \"Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__ ==\",\n \"= user # Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user)\",\n \"User: def __init__(self, user): self.user = user # Check if user exists def\",\n \"pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' % self.user except KeyError:\",\n \"# Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success =\",\n \"argument file module = AnsibleModule( argument_spec = dict( user = dict(required=True) ) )\",\n \"def main(): # Parsing argument file module = AnsibleModule( argument_spec = dict( user\",\n \"ret_msg = 'User %s does not exists' % self.user return success, ret_msg def\",\n \"ret_msg def main(): # Parsing argument file module = AnsibleModule( argument_spec = dict(\",\n \"def __init__(self, user): self.user = user # Check if user exists def check_if_user_exists(self):\",\n \"return success, ret_msg def main(): # Parsing argument file module = AnsibleModule( argument_spec\",\n \"KeyError: success = False ret_msg = 'User %s does not exists' % self.user\",\n \"module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON\",\n \"import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user =\",\n \"if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg\",\n \"__init__(self, user): self.user = user # Check if user exists def check_if_user_exists(self): try:\",\n \"= chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg)\",\n \"Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True\",\n \"not exists' % self.user return success, ret_msg def main(): # Parsing argument file\",\n \"% self.user return success, ret_msg def main(): # Parsing argument file module =\",\n \"argument_spec = dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr =\",\n \"user): self.user = user # Check if user exists def check_if_user_exists(self): try: user\",\n \") user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() # Error\",\n \"% self.user except KeyError: success = False ret_msg = 'User %s does not\",\n \"does not exists' % self.user return success, ret_msg def main(): # Parsing argument\",\n \"dict(required=True) ) ) user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists()\",\n \"except KeyError: success = False ret_msg = 'User %s does not exists' %\",\n \"try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' %\",\n \"import AnsibleModule class User: def __init__(self, user): self.user = user # Check if\",\n \"user # Check if user exists def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success\",\n \"#!/usr/bin/env python import pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user):\",\n \"user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s exists' % self.user\",\n \"False ret_msg = 'User %s does not exists' % self.user return success, ret_msg\",\n \"module = AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user =\",\n \"file module = AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user\",\n \"def check_if_user_exists(self): try: user = pwd.getpwnam(self.user) success = True ret_msg = 'User %s\",\n \"# Parsing argument file module = AnsibleModule( argument_spec = dict( user = dict(required=True)\",\n \"= 'User %s exists' % self.user except KeyError: success = False ret_msg =\",\n \"= True ret_msg = 'User %s exists' % self.user except KeyError: success =\",\n \"'User %s does not exists' % self.user return success, ret_msg def main(): #\",\n \"= User(user) success, ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if\",\n \"%s exists' % self.user except KeyError: success = False ret_msg = 'User %s\",\n \"success, ret_msg def main(): # Parsing argument file module = AnsibleModule( argument_spec =\",\n \") ) user = module.params.get('user') chkusr = User(user) success, ret_msg = chkusr.check_if_user_exists() #\",\n \"pwd from ansible.module_utils.basic import AnsibleModule class User: def __init__(self, user): self.user = user\",\n \"AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user = module.params.get('user') chkusr\",\n \"%s does not exists' % self.user return success, ret_msg def main(): # Parsing\",\n \"success = False ret_msg = 'User %s does not exists' % self.user return\",\n \"= 'User %s does not exists' % self.user return success, ret_msg def main():\",\n \"'User %s exists' % self.user except KeyError: success = False ret_msg = 'User\",\n \"main(): # Parsing argument file module = AnsibleModule( argument_spec = dict( user =\",\n \"handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__ == \\\"__main__\\\":\",\n \"= AnsibleModule( argument_spec = dict( user = dict(required=True) ) ) user = module.params.get('user')\",\n \"# Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__\",\n \"ret_msg = chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else:\",\n \"and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if __name__ == \\\"__main__\\\": main()\",\n \"AnsibleModule class User: def __init__(self, user): self.user = user # Check if user\",\n \"exists' % self.user return success, ret_msg def main(): # Parsing argument file module\",\n \"= False ret_msg = 'User %s does not exists' % self.user return success,\"\n]","isConversational":false}}},{"rowIdx":281,"cells":{"ngram":{"kind":"list like","value":["an appropriate ontology term. Args: label: the label to find ontology terms for","a given curie like 'CL:1000413', get the label like 'endothelial cell of artery'\"\"\"","and you want to find an appropriate ontology term. Args: label: the label","f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem with looking up ontology information.\"\"\" def","results Returns: list of (curie, label) tuples returned by OLS \"\"\" # using","response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label {label} lookup failed, got","ontology term. Args: label: the label to find ontology terms for ontology: the","else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413', get the","value. if not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a","the id component of the curie, 0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1]","OntologyLookupError( f\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\" ) return [(r[\"obo_id\"],","not url: return \"\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie","ontology term.\"\"\" # If the curie is empty, just return an empty string.","or efo for example method: select or search. search provides much broader results","_iri(curie): \"\"\"Get the iri from a curie. This is a bit hopeful that","bit hopeful that they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return","return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413', get the label","from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a url.","there is an existing label in a submitted dataset, and you want to","return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem with looking up ontology information.\"\"\"","label to find ontology terms for ontology: the ontology to search in, cl","f\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\" ) return [(r[\"obo_id\"], r[\"label\"])","CL:0000001 def _ontology_name(curie): \"\"\"Get the name of the ontology from the curie, CL","purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for","artery'\"\"\" url = _ontology_info_url(curie) if not url: return \"\" response = requests.get(url) if","search in, cl or uberon or efo for example method: select or search.","happens when there is no # valid ontology value. if not curie: return","OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok:","for example method: select or search. search provides much broader results Returns: list","REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok: raise","existing label in a submitted dataset, and you want to find an appropriate","(curie, label) tuples returned by OLS \"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api]","if not response.ok: raise OntologyLookupError( f\"Label {label} lookup failed, got status code {response.status_code}:","want to find an appropriate ontology term. Args: label: the label to find","for ontology: the ontology to search in, cl or uberon or efo for","This is useful when there is an existing label in a submitted dataset,","ontology to search in, cl or uberon or efo for example method: select","raise OntologyLookupError( f\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\" ) return","given curie like 'CL:1000413', get the label like 'endothelial cell of artery'\"\"\" url","def _ontology_name(curie): \"\"\"Get the name of the ontology from the curie, CL or","not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\"","response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a label. This is","to search in, cl or uberon or efo for example method: select or","looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make a GET to","url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label {label}","0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a","not response.ok: raise OntologyLookupError( f\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\"","= _ontology_info_url(curie) if not url: return \"\" response = requests.get(url) if not response.ok:","ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make a GET to to get","an empty string. This happens when there is no # valid ontology value.","url. This is required by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get","If the curie is empty, just return an empty string. This happens when","is an existing label in a submitted dataset, and you want to find","just return an empty string. This happens when there is no # valid","curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a url. This is required by the","terms for ontology: the ontology to search in, cl or uberon or efo","label in a submitted dataset, and you want to find an appropriate ontology","raise OntologyLookupError( f\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\" ) return","from the curie, CL or UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get","class OntologyLookupError(Exception): \"\"\"Exception for some problem with looking up ontology information.\"\"\" def _ontology_info_url(curie):","of artery'\"\"\" url = _ontology_info_url(curie) if not url: return \"\" response = requests.get(url)","OLS \"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response =","# Curie means something like CL:0000001 def _ontology_name(curie): \"\"\"Get the name of the","\"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413', get","requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label {label} lookup failed, got status code","they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\"","if not url: return \"\" response = requests.get(url) if not response.ok: raise OntologyLookupError(","\"\"\"Lookup candidate terms for a label. This is useful when there is an","'CL:1000413', get the label like 'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie) if","required by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from","terms for a label. This is useful when there is an existing label","broader results Returns: list of (curie, label) tuples returned by OLS \"\"\" #","if not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given","_ontology_info_url(curie) if not url: return \"\" response = requests.get(url) if not response.ok: raise","This is required by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the","is a bit hopeful that they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) ==","string. This happens when there is no # valid ontology value. if not","label: the label to find ontology terms for ontology: the ontology to search","dataset, and you want to find an appropriate ontology term. Args: label: the","the ontology from the curie, CL or UBERON for example.\"\"\" return curie.split(\":\")[0] def","uberon or efo for example method: select or search. search provides much broader","Curie means something like CL:0000001 def _ontology_name(curie): \"\"\"Get the name of the ontology","much broader results Returns: list of (curie, label) tuples returned by OLS \"\"\"","_ontology_info_url(curie): \"\"\"Get the to make a GET to to get information about an","there is no # valid ontology value. if not curie: return \"\" else:","when there is an existing label in a submitted dataset, and you want","for working with ontologies and the OLS.\"\"\" from urllib.parse import quote_plus import requests","encode a url. This is required by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def","f\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def","by OLS \"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response","problem with looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make a","_ontology_name(curie): \"\"\"Get the name of the ontology from the curie, CL or UBERON","submitted dataset, and you want to find an appropriate ontology term. Args: label:","find ontology terms for ontology: the ontology to search in, cl or uberon","Returns: list of (curie, label) tuples returned by OLS \"\"\" # using OLS","about an ontology term.\"\"\" # If the curie is empty, just return an","return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a url. This is required by","def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a label. This is useful","# valid ontology value. if not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def","to get information about an ontology term.\"\"\" # If the curie is empty,","OntologyLookupError( f\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"]","# If the curie is empty, just return an empty string. This happens","the label like 'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie) if not url:","OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001 def _ontology_name(curie): \"\"\"Get the","the OLS.\"\"\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie","{response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a","ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a label. This is useful when there","example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component of the curie, 0000001","search provides much broader results Returns: list of (curie, label) tuples returned by","information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make a GET to to get information","tuples returned by OLS \"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url =","a GET to to get information about an ontology term.\"\"\" # If the","curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie like","useful when there is an existing label in a submitted dataset, and you","= f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label {label} lookup","\"\"\"For a given curie like 'CL:1000413', get the label like 'endothelial cell of","in, cl or uberon or efo for example method: select or search. search","_ontology_value(curie): \"\"\"Get the id component of the curie, 0000001 from CL:0000001 for example.\"\"\"","to find an appropriate ontology term. Args: label: the label to find ontology","method: select or search. search provides much broader results Returns: list of (curie,","you want to find an appropriate ontology term. Args: label: the label to","no # valid ontology value. if not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\"","url: return \"\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie {curie}","of the ontology from the curie, CL or UBERON for example.\"\"\" return curie.split(\":\")[0]","a bit hopeful that they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\":","to make a GET to to get information about an ontology term.\"\"\" #","get information about an ontology term.\"\"\" # If the curie is empty, just","curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component of the curie, 0000001 from CL:0000001","the curie is empty, just return an empty string. This happens when there","= \"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001 def _ontology_name(curie): \"\"\"Get the name","lookup failed, got status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\",","iri from a curie. This is a bit hopeful that they all map","component of the curie, 0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url):","failed, got status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"):","or search. search provides much broader results Returns: list of (curie, label) tuples","like 'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie) if not url: return \"\"","means something like CL:0000001 def _ontology_name(curie): \"\"\"Get the name of the ontology from","\"\"\"Get the to make a GET to to get information about an ontology","= requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed, got status","return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a label. This","f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem with looking up ontology","is useful when there is an existing label in a submitted dataset, and","an existing label in a submitted dataset, and you want to find an","empty, just return an empty string. This happens when there is no #","with ontologies and the OLS.\"\"\" from urllib.parse import quote_plus import requests OLS_API_ROOT =","OLS.\"\"\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means","working with ontologies and the OLS.\"\"\" from urllib.parse import quote_plus import requests OLS_API_ROOT","id component of the curie, 0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def","cell of artery'\"\"\" url = _ontology_info_url(curie) if not url: return \"\" response =","{response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for","UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component of the","example method: select or search. search provides much broader results Returns: list of","{curie} lookup failed, got status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label,","the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from a curie.","lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a label. This is useful when","example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a url. This is required","method=\"select\"): \"\"\"Lookup candidate terms for a label. This is useful when there is","a label. This is useful when there is an existing label in a","valid ontology value. if not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie):","return an empty string. This happens when there is no # valid ontology","hopeful that they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\"","\"\"\"Exception for some problem with looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the","if not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed, got status code {response.status_code}:","return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413',","or UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component of","like 'CL:1000413', get the label like 'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie)","in a submitted dataset, and you want to find an appropriate ontology term.","label) tuples returned by OLS \"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url","an ontology term.\"\"\" # If the curie is empty, just return an empty","response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\" )","all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class","map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception):","that they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return","= requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label {label} lookup failed, got status","def _iri(curie): \"\"\"Get the iri from a curie. This is a bit hopeful","the label to find ontology terms for ontology: the ontology to search in,","for some problem with looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to","for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component of the curie,","the curie, 0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url","to purl.obolibrary.org\"\"\" if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception","term.\"\"\" # If the curie is empty, just return an empty string. This","some problem with looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make","returned by OLS \"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\"","is empty, just return an empty string. This happens when there is no","return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from a curie. This is a",") return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms for a label.","find an appropriate ontology term. Args: label: the label to find ontology terms","cl or uberon or efo for example method: select or search. search provides","f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label {label} lookup failed,","like CL:0000001 def _ontology_name(curie): \"\"\"Get the name of the ontology from the curie,","{label} lookup failed, got status code {response.status_code}: {response.text}\" ) return [(r[\"obo_id\"], r[\"label\"]) for","return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component of the curie, 0000001 from","API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from a curie. This is","def _ontology_value(curie): \"\"\"Get the id component of the curie, 0000001 from CL:0000001 for","from urllib.parse import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something","is required by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri","for a label. This is useful when there is an existing label in","status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate","API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok: raise OntologyLookupError(","failed, got status code {response.status_code}: {response.text}\" ) return [(r[\"obo_id\"], r[\"label\"]) for r in","response.ok: raise OntologyLookupError( f\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\" )","\"\"\"Methods for working with ontologies and the OLS.\"\"\" from urllib.parse import quote_plus import","not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie","select or search. search provides much broader results Returns: list of (curie, label)","\"\"\"Get the name of the ontology from the curie, CL or UBERON for","name of the ontology from the curie, CL or UBERON for example.\"\"\" return","Args: label: the label to find ontology terms for ontology: the ontology to","response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed, got","\"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001 def _ontology_name(curie): \"\"\"Get the name of","if _ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some","ontology value. if not curie: return \"\" else: return f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For","\"\"\"Get the iri from a curie. This is a bit hopeful that they","\"\"\"Get the id component of the curie, 0000001 from CL:0000001 for example.\"\"\" return","requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001 def _ontology_name(curie): \"\"\"Get","\"\"\"Double url encode a url. This is required by the OLS API.\"\"\" return","curie, CL or UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id","url = _ontology_info_url(curie) if not url: return \"\" response = requests.get(url) if not","to find ontology terms for ontology: the ontology to search in, cl or","lookup failed, got status code {response.status_code}: {response.text}\" ) return [(r[\"obo_id\"], r[\"label\"]) for r","_double_encode(url): \"\"\"Double url encode a url. This is required by the OLS API.\"\"\"","the to make a GET to to get information about an ontology term.\"\"\"","term. Args: label: the label to find ontology terms for ontology: the ontology","\"\"\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url)","get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413', get the label like 'endothelial cell","from a curie. This is a bit hopeful that they all map to","a submitted dataset, and you want to find an appropriate ontology term. Args:","url encode a url. This is required by the OLS API.\"\"\" return quote_plus(quote_plus(url))","This is a bit hopeful that they all map to purl.obolibrary.org\"\"\" if _ontology_name(curie)","and the OLS.\"\"\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" #","something like CL:0000001 def _ontology_name(curie): \"\"\"Get the name of the ontology from the","OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from a curie. This","empty string. This happens when there is no # valid ontology value. if","is no # valid ontology value. if not curie: return \"\" else: return","code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup candidate terms","a url. This is required by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie):","f\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\" def get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413', get the label like","return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem with looking up","def _ontology_info_url(curie): \"\"\"Get the to make a GET to to get information about","\"\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed,","requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup failed, got status code","efo for example method: select or search. search provides much broader results Returns:","list of (curie, label) tuples returned by OLS \"\"\" # using OLS REST","curie. This is a bit hopeful that they all map to purl.obolibrary.org\"\"\" if","of the curie, 0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double","import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001 def _ontology_name(curie):","to to get information about an ontology term.\"\"\" # If the curie is","This happens when there is no # valid ontology value. if not curie:","def _double_encode(url): \"\"\"Double url encode a url. This is required by the OLS","\"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem with looking","candidate terms for a label. This is useful when there is an existing","ontologies and the OLS.\"\"\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\"","up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make a GET to to","ontology from the curie, CL or UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie):","import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001","by the OLS API.\"\"\" return quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from a","information about an ontology term.\"\"\" # If the curie is empty, just return","== \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem with","return \"\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Curie {curie} lookup","ontology: the ontology to search in, cl or uberon or efo for example","'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie) if not url: return \"\" response","search. search provides much broader results Returns: list of (curie, label) tuples returned","make a GET to to get information about an ontology term.\"\"\" # If","label like 'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie) if not url: return","for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a url. This is","or uberon or efo for example method: select or search. search provides much","the curie, CL or UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the","label. This is useful when there is an existing label in a submitted","curie like 'CL:1000413', get the label like 'endothelial cell of artery'\"\"\" url =","with looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get the to make a GET","using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not","curie, 0000001 from CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode","of (curie, label) tuples returned by OLS \"\"\" # using OLS REST API","curie is empty, just return an empty string. This happens when there is","got status code {response.status_code}: {response.text}\" ) return response.json()[\"label\"] def lookup_candidate_term(label, ontology=\"cl\", method=\"select\"): \"\"\"Lookup","[https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\"Label","def get_ontology_label(curie): \"\"\"For a given curie like 'CL:1000413', get the label like 'endothelial","the ontology to search in, cl or uberon or efo for example method:","OntologyLookupError(Exception): \"\"\"Exception for some problem with looking up ontology information.\"\"\" def _ontology_info_url(curie): \"\"\"Get","appropriate ontology term. Args: label: the label to find ontology terms for ontology:","CL or UBERON for example.\"\"\" return curie.split(\":\")[0] def _ontology_value(curie): \"\"\"Get the id component","_ontology_name(curie) == \"EFO\": return f\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\" return f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\" class OntologyLookupError(Exception): \"\"\"Exception for some problem","# using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\" response = requests.get(url) if","ontology terms for ontology: the ontology to search in, cl or uberon or","GET to to get information about an ontology term.\"\"\" # If the curie","got status code {response.status_code}: {response.text}\" ) return [(r[\"obo_id\"], r[\"label\"]) for r in response.json()[\"response\"][\"docs\"]]","the iri from a curie. This is a bit hopeful that they all","a curie. This is a bit hopeful that they all map to purl.obolibrary.org\"\"\"","get the label like 'endothelial cell of artery'\"\"\" url = _ontology_info_url(curie) if not","the name of the ontology from the curie, CL or UBERON for example.\"\"\"","when there is no # valid ontology value. if not curie: return \"\"","CL:0000001 for example.\"\"\" return curie.split(\":\")[1] def _double_encode(url): \"\"\"Double url encode a url. This","provides much broader results Returns: list of (curie, label) tuples returned by OLS","quote_plus(quote_plus(url)) def _iri(curie): \"\"\"Get the iri from a curie. This is a bit","quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something like CL:0000001 def","urllib.parse import quote_plus import requests OLS_API_ROOT = \"http://www.ebi.ac.uk/ols/api\" # Curie means something like"],"string":"[\n \"an appropriate ontology term. Args: label: the label to find ontology terms for\",\n \"a given curie like 'CL:1000413', get the label like 'endothelial cell of artery'\\\"\\\"\\\"\",\n \"and you want to find an appropriate ontology term. Args: label: the label\",\n \"f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking up ontology information.\\\"\\\"\\\" def\",\n \"results Returns: list of (curie, label) tuples returned by OLS \\\"\\\"\\\" # using\",\n \"response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed, got\",\n \"ontology term. Args: label: the label to find ontology terms for ontology: the\",\n \"else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413', get the\",\n \"value. if not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a\",\n \"the id component of the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1]\",\n \"OntologyLookupError( f\\\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return [(r[\\\"obo_id\\\"],\",\n \"not url: return \\\"\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie\",\n \"ontology term.\\\"\\\"\\\" # If the curie is empty, just return an empty string.\",\n \"or efo for example method: select or search. search provides much broader results\",\n \"_iri(curie): \\\"\\\"\\\"Get the iri from a curie. This is a bit hopeful that\",\n \"bit hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return\",\n \"return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413', get the label\",\n \"from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a url.\",\n \"there is an existing label in a submitted dataset, and you want to\",\n \"return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking up ontology information.\\\"\\\"\\\"\",\n \"label to find ontology terms for ontology: the ontology to search in, cl\",\n \"f\\\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return [(r[\\\"obo_id\\\"], r[\\\"label\\\"])\",\n \"CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology from the curie, CL\",\n \"purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for\",\n \"artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url: return \\\"\\\" response = requests.get(url) if\",\n \"search in, cl or uberon or efo for example method: select or search.\",\n \"happens when there is no # valid ontology value. if not curie: return\",\n \"OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok:\",\n \"for example method: select or search. search provides much broader results Returns: list\",\n \"REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok: raise\",\n \"existing label in a submitted dataset, and you want to find an appropriate\",\n \"(curie, label) tuples returned by OLS \\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api]\",\n \"if not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed, got status code {response.status_code}:\",\n \"want to find an appropriate ontology term. Args: label: the label to find\",\n \"for ontology: the ontology to search in, cl or uberon or efo for\",\n \"This is useful when there is an existing label in a submitted dataset,\",\n \"ontology to search in, cl or uberon or efo for example method: select\",\n \"raise OntologyLookupError( f\\\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return\",\n \"given curie like 'CL:1000413', get the label like 'endothelial cell of artery'\\\"\\\"\\\" url\",\n \"def _ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology from the curie, CL or\",\n \"not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\\\"\",\n \"response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label. This is\",\n \"to search in, cl or uberon or efo for example method: select or\",\n \"looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET to\",\n \"url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label {label}\",\n \"0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a\",\n \"not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\\\"\",\n \"= _ontology_info_url(curie) if not url: return \\\"\\\" response = requests.get(url) if not response.ok:\",\n \"ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET to to get\",\n \"an empty string. This happens when there is no # valid ontology value.\",\n \"url. This is required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get\",\n \"If the curie is empty, just return an empty string. This happens when\",\n \"is an existing label in a submitted dataset, and you want to find\",\n \"just return an empty string. This happens when there is no # valid\",\n \"curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a url. This is required by the\",\n \"terms for ontology: the ontology to search in, cl or uberon or efo\",\n \"label in a submitted dataset, and you want to find an appropriate ontology\",\n \"raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return\",\n \"from the curie, CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get\",\n \"class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie):\",\n \"of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url: return \\\"\\\" response = requests.get(url)\",\n \"OLS \\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response =\",\n \"# Curie means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of the\",\n \"\\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413', get\",\n \"requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed, got status code\",\n \"they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\"\",\n \"if not url: return \\\"\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError(\",\n \"\\\"\\\"\\\"Lookup candidate terms for a label. This is useful when there is an\",\n \"'CL:1000413', get the label like 'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if\",\n \"required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from\",\n \"terms for a label. This is useful when there is an existing label\",\n \"broader results Returns: list of (curie, label) tuples returned by OLS \\\"\\\"\\\" #\",\n \"if not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given\",\n \"_ontology_info_url(curie) if not url: return \\\"\\\" response = requests.get(url) if not response.ok: raise\",\n \"This is required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the\",\n \"is a bit hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) ==\",\n \"string. This happens when there is no # valid ontology value. if not\",\n \"label: the label to find ontology terms for ontology: the ontology to search\",\n \"dataset, and you want to find an appropriate ontology term. Args: label: the\",\n \"the ontology from the curie, CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def\",\n \"uberon or efo for example method: select or search. search provides much broader\",\n \"Curie means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology\",\n \"much broader results Returns: list of (curie, label) tuples returned by OLS \\\"\\\"\\\"\",\n \"_ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET to to get information about an\",\n \"there is no # valid ontology value. if not curie: return \\\"\\\" else:\",\n \"when there is an existing label in a submitted dataset, and you want\",\n \"for working with ontologies and the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests\",\n \"encode a url. This is required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def\",\n \"f\\\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def\",\n \"by OLS \\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response\",\n \"problem with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a\",\n \"_ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology from the curie, CL or UBERON\",\n \"submitted dataset, and you want to find an appropriate ontology term. Args: label:\",\n \"find ontology terms for ontology: the ontology to search in, cl or uberon\",\n \"Returns: list of (curie, label) tuples returned by OLS \\\"\\\"\\\" # using OLS\",\n \"about an ontology term.\\\"\\\"\\\" # If the curie is empty, just return an\",\n \"return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a url. This is required by\",\n \"def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label. This is useful\",\n \"# valid ontology value. if not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def\",\n \"to get information about an ontology term.\\\"\\\"\\\" # If the curie is empty,\",\n \"OntologyLookupError( f\\\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"]\",\n \"# If the curie is empty, just return an empty string. This happens\",\n \"the label like 'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url:\",\n \"OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the\",\n \"the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie\",\n \"{response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a\",\n \"ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label. This is useful when there\",\n \"example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component of the curie, 0000001\",\n \"search provides much broader results Returns: list of (curie, label) tuples returned by\",\n \"information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET to to get information\",\n \"tuples returned by OLS \\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url =\",\n \"a GET to to get information about an ontology term.\\\"\\\"\\\" # If the\",\n \"curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like\",\n \"useful when there is an existing label in a submitted dataset, and you\",\n \"= f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup\",\n \"\\\"\\\"\\\"For a given curie like 'CL:1000413', get the label like 'endothelial cell of\",\n \"in, cl or uberon or efo for example method: select or search. search\",\n \"_ontology_value(curie): \\\"\\\"\\\"Get the id component of the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\"\",\n \"to find an appropriate ontology term. Args: label: the label to find ontology\",\n \"method: select or search. search provides much broader results Returns: list of (curie,\",\n \"you want to find an appropriate ontology term. Args: label: the label to\",\n \"no # valid ontology value. if not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\"\",\n \"url: return \\\"\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie {curie}\",\n \"of the ontology from the curie, CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0]\",\n \"a bit hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\":\",\n \"to make a GET to to get information about an ontology term.\\\"\\\"\\\" #\",\n \"get information about an ontology term.\\\"\\\"\\\" # If the curie is empty, just\",\n \"curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component of the curie, 0000001 from CL:0000001\",\n \"the curie is empty, just return an empty string. This happens when there\",\n \"= \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name\",\n \"lookup failed, got status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\",\",\n \"iri from a curie. This is a bit hopeful that they all map\",\n \"component of the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url):\",\n \"failed, got status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"):\",\n \"or search. search provides much broader results Returns: list of (curie, label) tuples\",\n \"like 'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url: return \\\"\\\"\",\n \"means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology from\",\n \"\\\"\\\"\\\"Get the to make a GET to to get information about an ontology\",\n \"= requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got status\",\n \"return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label. This\",\n \"f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking up ontology\",\n \"is useful when there is an existing label in a submitted dataset, and\",\n \"an existing label in a submitted dataset, and you want to find an\",\n \"empty, just return an empty string. This happens when there is no #\",\n \"with ontologies and the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests OLS_API_ROOT =\",\n \"OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means\",\n \"working with ontologies and the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests OLS_API_ROOT\",\n \"id component of the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def\",\n \"cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url: return \\\"\\\" response =\",\n \"{response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for\",\n \"UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component of the\",\n \"example method: select or search. search provides much broader results Returns: list of\",\n \"{curie} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label,\",\n \"the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from a curie.\",\n \"lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label. This is useful when\",\n \"example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a url. This is required\",\n \"method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label. This is useful when there is\",\n \"a label. This is useful when there is an existing label in a\",\n \"valid ontology value. if not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie):\",\n \"return an empty string. This happens when there is no # valid ontology\",\n \"hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\"\",\n \"\\\"\\\"\\\"Exception for some problem with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the\",\n \"if not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got status code {response.status_code}:\",\n \"return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413',\",\n \"or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component of\",\n \"like 'CL:1000413', get the label like 'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie)\",\n \"in a submitted dataset, and you want to find an appropriate ontology term.\",\n \"label) tuples returned by OLS \\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url\",\n \"an ontology term.\\\"\\\"\\\" # If the curie is empty, just return an empty\",\n \"response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got status code {response.status_code}: {response.text}\\\" )\",\n \"all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class\",\n \"map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception):\",\n \"that they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return\",\n \"= requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed, got status\",\n \"def _iri(curie): \\\"\\\"\\\"Get the iri from a curie. This is a bit hopeful\",\n \"the label to find ontology terms for ontology: the ontology to search in,\",\n \"for some problem with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to\",\n \"for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component of the curie,\",\n \"the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url\",\n \"to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception\",\n \"term.\\\"\\\"\\\" # If the curie is empty, just return an empty string. This\",\n \"some problem with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make\",\n \"returned by OLS \\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\"\",\n \"is empty, just return an empty string. This happens when there is no\",\n \"return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from a curie. This is a\",\n \") return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms for a label.\",\n \"find an appropriate ontology term. Args: label: the label to find ontology terms\",\n \"cl or uberon or efo for example method: select or search. search provides\",\n \"f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed,\",\n \"like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology from the curie,\",\n \"{label} lookup failed, got status code {response.status_code}: {response.text}\\\" ) return [(r[\\\"obo_id\\\"], r[\\\"label\\\"]) for\",\n \"return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component of the curie, 0000001 from\",\n \"API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from a curie. This is\",\n \"def _ontology_value(curie): \\\"\\\"\\\"Get the id component of the curie, 0000001 from CL:0000001 for\",\n \"from urllib.parse import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something\",\n \"is required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri\",\n \"for a label. This is useful when there is an existing label in\",\n \"status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate\",\n \"API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError(\",\n \"failed, got status code {response.status_code}: {response.text}\\\" ) return [(r[\\\"obo_id\\\"], r[\\\"label\\\"]) for r in\",\n \"response.ok: raise OntologyLookupError( f\\\"Label {label} lookup failed, got status code {response.status_code}: {response.text}\\\" )\",\n \"\\\"\\\"\\\"Methods for working with ontologies and the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import\",\n \"not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie\",\n \"select or search. search provides much broader results Returns: list of (curie, label)\",\n \"\\\"\\\"\\\"Get the name of the ontology from the curie, CL or UBERON for\",\n \"name of the ontology from the curie, CL or UBERON for example.\\\"\\\"\\\" return\",\n \"Args: label: the label to find ontology terms for ontology: the ontology to\",\n \"response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got\",\n \"\\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of\",\n \"if _ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some\",\n \"ontology value. if not curie: return \\\"\\\" else: return f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For\",\n \"\\\"\\\"\\\"Get the iri from a curie. This is a bit hopeful that they\",\n \"\\\"\\\"\\\"Get the id component of the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return\",\n \"requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get\",\n \"\\\"\\\"\\\"Double url encode a url. This is required by the OLS API.\\\"\\\"\\\" return\",\n \"curie, CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id\",\n \"url = _ontology_info_url(curie) if not url: return \\\"\\\" response = requests.get(url) if not\",\n \"to find ontology terms for ontology: the ontology to search in, cl or\",\n \"lookup failed, got status code {response.status_code}: {response.text}\\\" ) return [(r[\\\"obo_id\\\"], r[\\\"label\\\"]) for r\",\n \"_double_encode(url): \\\"\\\"\\\"Double url encode a url. This is required by the OLS API.\\\"\\\"\\\"\",\n \"the to make a GET to to get information about an ontology term.\\\"\\\"\\\"\",\n \"term. Args: label: the label to find ontology terms for ontology: the ontology\",\n \"\\\"\\\"\\\" # using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url)\",\n \"get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413', get the label like 'endothelial cell\",\n \"from a curie. This is a bit hopeful that they all map to\",\n \"a submitted dataset, and you want to find an appropriate ontology term. Args:\",\n \"url encode a url. This is required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url))\",\n \"This is a bit hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\" if _ontology_name(curie)\",\n \"and the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" #\",\n \"something like CL:0000001 def _ontology_name(curie): \\\"\\\"\\\"Get the name of the ontology from the\",\n \"OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from a curie. This\",\n \"empty string. This happens when there is no # valid ontology value. if\",\n \"is no # valid ontology value. if not curie: return \\\"\\\" else: return\",\n \"code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup candidate terms\",\n \"a url. This is required by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie):\",\n \"f\\\"{OLS_API_ROOT}/ontologies/{_ontology_name(curie)}/terms/{_double_encode(_iri(curie))}\\\" def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413', get the label like\",\n \"return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking up\",\n \"def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET to to get information about\",\n \"\\\"\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed,\",\n \"requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup failed, got status code\",\n \"efo for example method: select or search. search provides much broader results Returns:\",\n \"list of (curie, label) tuples returned by OLS \\\"\\\"\\\" # using OLS REST\",\n \"curie. This is a bit hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\" if\",\n \"of the curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double\",\n \"import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001 def _ontology_name(curie):\",\n \"to to get information about an ontology term.\\\"\\\"\\\" # If the curie is\",\n \"This happens when there is no # valid ontology value. if not curie:\",\n \"def _double_encode(url): \\\"\\\"\\\"Double url encode a url. This is required by the OLS\",\n \"\\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking\",\n \"candidate terms for a label. This is useful when there is an existing\",\n \"ontologies and the OLS.\\\"\\\"\\\" from urllib.parse import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\"\",\n \"up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET to to\",\n \"ontology from the curie, CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie):\",\n \"import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001\",\n \"by the OLS API.\\\"\\\"\\\" return quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from a\",\n \"information about an ontology term.\\\"\\\"\\\" # If the curie is empty, just return\",\n \"== \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with\",\n \"return \\\"\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Curie {curie} lookup\",\n \"ontology: the ontology to search in, cl or uberon or efo for example\",\n \"'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url: return \\\"\\\" response\",\n \"search. search provides much broader results Returns: list of (curie, label) tuples returned\",\n \"make a GET to to get information about an ontology term.\\\"\\\"\\\" # If\",\n \"label like 'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not url: return\",\n \"for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a url. This is\",\n \"or uberon or efo for example method: select or search. search provides much\",\n \"the curie, CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the\",\n \"label. This is useful when there is an existing label in a submitted\",\n \"curie like 'CL:1000413', get the label like 'endothelial cell of artery'\\\"\\\"\\\" url =\",\n \"with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get the to make a GET\",\n \"using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not\",\n \"curie, 0000001 from CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode\",\n \"of (curie, label) tuples returned by OLS \\\"\\\"\\\" # using OLS REST API\",\n \"curie is empty, just return an empty string. This happens when there is\",\n \"got status code {response.status_code}: {response.text}\\\" ) return response.json()[\\\"label\\\"] def lookup_candidate_term(label, ontology=\\\"cl\\\", method=\\\"select\\\"): \\\"\\\"\\\"Lookup\",\n \"[https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if not response.ok: raise OntologyLookupError( f\\\"Label\",\n \"def get_ontology_label(curie): \\\"\\\"\\\"For a given curie like 'CL:1000413', get the label like 'endothelial\",\n \"the ontology to search in, cl or uberon or efo for example method:\",\n \"OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem with looking up ontology information.\\\"\\\"\\\" def _ontology_info_url(curie): \\\"\\\"\\\"Get\",\n \"appropriate ontology term. Args: label: the label to find ontology terms for ontology:\",\n \"CL or UBERON for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[0] def _ontology_value(curie): \\\"\\\"\\\"Get the id component\",\n \"_ontology_name(curie) == \\\"EFO\\\": return f\\\"http://www.ebi.ac.uk/efo/EFO_{_ontology_value(curie)}\\\" return f\\\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{_ontology_value(curie)}\\\" class OntologyLookupError(Exception): \\\"\\\"\\\"Exception for some problem\",\n \"# using OLS REST API [https://www.ebi.ac.uk/ols/docs/api] url = f\\\"{OLS_API_ROOT}/{method}?q={quote_plus(label)}&ontology={ontology.lower()}\\\" response = requests.get(url) if\",\n \"ontology terms for ontology: the ontology to search in, cl or uberon or\",\n \"GET to to get information about an ontology term.\\\"\\\"\\\" # If the curie\",\n \"got status code {response.status_code}: {response.text}\\\" ) return [(r[\\\"obo_id\\\"], r[\\\"label\\\"]) for r in response.json()[\\\"response\\\"][\\\"docs\\\"]]\",\n \"the iri from a curie. This is a bit hopeful that they all\",\n \"a curie. This is a bit hopeful that they all map to purl.obolibrary.org\\\"\\\"\\\"\",\n \"get the label like 'endothelial cell of artery'\\\"\\\"\\\" url = _ontology_info_url(curie) if not\",\n \"the name of the ontology from the curie, CL or UBERON for example.\\\"\\\"\\\"\",\n \"when there is no # valid ontology value. if not curie: return \\\"\\\"\",\n \"CL:0000001 for example.\\\"\\\"\\\" return curie.split(\\\":\\\")[1] def _double_encode(url): \\\"\\\"\\\"Double url encode a url. This\",\n \"provides much broader results Returns: list of (curie, label) tuples returned by OLS\",\n \"quote_plus(quote_plus(url)) def _iri(curie): \\\"\\\"\\\"Get the iri from a curie. This is a bit\",\n \"quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like CL:0000001 def\",\n \"urllib.parse import quote_plus import requests OLS_API_ROOT = \\\"http://www.ebi.ac.uk/ols/api\\\" # Curie means something like\"\n]","isConversational":false}}},{"rowIdx":282,"cells":{"ngram":{"kind":"list like","value":["\"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\"","TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE","'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have","[{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } .. code-block:: http","\"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation","the system will magically switch between both meaning. This is an attempt at","http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All questions related to languages\"","return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to a ``Matrix`` derived","self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter,","accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags, \\","import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import","SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT","this list of conditions and the following disclaimer. # 2. Redistributions in binary","'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts",".. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All questions related","\"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } \"\"\" serializer_class = MatrixSerializer","= len(questions) if nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter):","def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter =","without # modification, are permitted provided that the following conditions are met: #","**includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts","request, *args, **kwargs): \"\"\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http","(get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView):","likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self,","code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\": \"all\", \"title\": \"All\",","\"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request,","All rights reserved. # # Redistribution and use in source and binary forms,","EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix","= matrix.cut if not cohorts: # We don't have any cohorts, let's show","\"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_question_serializer()","import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer,","get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts","retain the above copyright notice, # this list of conditions and the following","= view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([","if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers","\"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\":","scores for cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response:","[scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\":","EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self,","**kwargs) def delete(self, request, *args, **kwargs): \"\"\" Deletes a fitler **Tags**: survey **Examples**","IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED.","\"\"\" List filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1","cohort_slug): \"\"\" Returns a URL to a ``Matrix`` derived from *cohort*. Many times","#pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler",".. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args,","metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix =","\"\" } ] } \"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self,","and the following disclaimer. # 2. Redistributions in binary form must reproduce the","THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF","\"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } Response: 201","..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model,","queryset of `Account` ... cohorts = accounts result = [] scores = {}","name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric","LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,","#pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs)","LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT","let's show individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts =","accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores = {} if","\"predicates\": [] }] } Response: 201 CREATED { \"slug\": \"all\", \"title\": \"All accounts","likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result +=","json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\":","provided that the following conditions are met: # # 1. Redistributions of source","12 } \"\"\" pagination_class = EditableFilterPagination serializer_class = None # override in subclasses","for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val)","from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from","100 scores.update({str(cohort): score}) return {\"scores\": scores} @property def matrix(self): if not hasattr(self, '_matrix'):","an queryset # of `EditableFilter` to a queryset of `Account` ... cohorts =","likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts,","some case, a metric and cohort have a connection # and could have","queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count),","\"\"\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1","= self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric =","are met: # # 1. Redistributions of source code must retain the above","\"title\": \"All accounts against all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\",","OF SUCH DAMAGE. import logging, re from collections import OrderedDict from django.db.models import","\"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\":","conditions and the following disclaimer in the # documentation and/or other materials provided","/api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\",","], \"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg =",".. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2,","responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class =","and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED","* nb_accounts) LOGGER.debug(\"score for '%s' = (%d * 100) \"\\ \"/ (%d *","\"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class","of `EditableFilter` to a queryset of `Account` ... cohorts = accounts result =","EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples** .. code-block::","{\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class","self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\"","matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't","permitted provided that the following conditions are met: # # 1. Redistributions of","EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object):","extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework","accounts is None: accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric'","TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE","WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF","{ 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In","\"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ],","super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**:","NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A","notice, this list of conditions and the following disclaimer in the # documentation","= matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We","# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections","+= [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin,","http from ..compat import reverse from ..mixins import MatrixMixin from ..models import Answer,","EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView):","results: [ { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1,","DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination):","view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter',","all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": [] }, \"cohorts\":","lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals","code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \"slug\": \"all\", \"title\":","return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None):","http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12","http GET /api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All accounts against all questions\",","nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' = (%d","public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result","sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score","AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR","class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/","*args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http","will be a list of single account objects. qs_accounts = [cohort] nb_accounts =","\"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } Response: 201 CREATED { \"slug\":","with or without # modification, are permitted provided that the following conditions are","INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, #","assert score <= 100 scores.update({str(cohort): score}) return {\"scores\": scores} @property def matrix(self): if","\"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\": \"None\",","http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\",","code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1,",".. code-block:: http GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts for","EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort","not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate')","measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score for","*args, **kwargs): \"\"\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE","in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores(","request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter","NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY","OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER","Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics","*cohort*. Many times people will use the same name to either mean a","OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER","#pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/')","excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions >","HTTP/1.1 responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\":","following conditions are met: # # 1. Redistributions of source code must retain","metric.tags, \\ \"filter '%s' is not tagged as a metric\" % str(metric) includes,","# # 1. Redistributions of source code must retain the above copyright notice,","MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT","serializer_class = None # override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter'","\"\"\" A table of scores for cohorts aganist a metric. **Examples**: .. code-block::","OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR","ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED","= Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate')","( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' = (%d * 100) \"\\ \"/","Response: { \"slug\": \"languages\", \"title\": \"All questions related to languages\" \"predicates\":[{ \"operator\": \"contains\",","previous: null, next: null, results: [ { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\",","Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\"","100) \"\\ \"/ (%d * %d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score)","in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes)","code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination serializer_class","Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions *","modification, are permitted provided that the following conditions are met: # # 1.","= {} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut),","from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list","# of `EditableFilter` to a queryset of `Account` ... cohorts = accounts result","= cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer()","EditableFilterPagination serializer_class = None # override in subclasses lookup_field = 'slug' lookup_url_kwarg =","... cohorts = accounts result = [] scores = {} val = {","# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR #","search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\" Create","CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL","# documentation and/or other materials provided with the distribution. # # THIS SOFTWARE","= 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args,","for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class =","ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED","rights reserved. # # Redistribution and use in source and binary forms, with","import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import","(%d * %d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <=","+= [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data,","\"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\",","could have the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if",".. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\":","**kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET",".. code-block:: http POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts against all","a connection # and could have the same name. for cohort in val['cohorts']:","show individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter(","provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT","Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\",","Redistributions in binary form must reproduce the above copyright # notice, this list","score) assert score <= 100 scores.update({str(cohort): score}) return {\"scores\": scores} @property def matrix(self):","\"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list","# If `matrix.cohorts is None`, the `cohorts` argument # will be a list","use the same name to either mean a cohort or a metric and","Implementation Note: switch cohorts from an queryset # of `EditableFilter` to a queryset","queryset # of `EditableFilter` to a queryset of `Account` ... cohorts = accounts","args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals","get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\"","CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR","*args, **kwargs): \"\"\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT","Copyright (c) 2020, DjaoDjin inc. # All rights reserved. # # Redistribution and","get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags, \\ \"filter '%s'","accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation","\"\"\" Create a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1","str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if","}, { \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\":","reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs):","val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)}","inc. # All rights reserved. # # Redistribution and use in source and","aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all()","\"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\":","} \"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self):","of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\":","None`, the `cohorts` argument # will be a list of single account objects.","= EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\" Create a fitler **Tags**: survey","http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous: null,","\"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\"","(INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS","SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging,","'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None):","MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric,","get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to a ``Matrix`` derived from *cohort*. Many","http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous: null,","have the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric:","OrderedDict from django.db.models import F from django.http import Http404 from django.shortcuts import get_object_or_404","EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/","of source code must retain the above copyright notice, # this list of","'_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def","**Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json","= get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http","= {} if metric: assert 'metric' in metric.tags, \\ \"filter '%s' is not","SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND","<= 100 scores.update({str(cohort): score}) return {\"scores\": scores} @property def matrix(self): if not hasattr(self,","GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All questions related to languages\" \"predicates\":[{","= cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the","disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class","accounts\", \"predicates\": [] }] } \"\"\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all()","**Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\":","\"title\": \"All accounts\", \"predicates\": [] }] } \"\"\" serializer_class = MatrixSerializer def get_queryset(self):","Redistributions of source code must retain the above copyright notice, # this list","GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous: null, next:","] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\"","THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,","get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric","from django.db.models import F from django.http import Http404 from django.shortcuts import get_object_or_404 from","PageNumberPagination from rest_framework import response as http from ..compat import reverse from ..mixins","URL to a ``Matrix`` derived from *cohort*. Many times people will use the","PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; #","DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;","generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as http from ..compat","COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES,","{} if metric: assert 'metric' in metric.tags, \\ \"filter '%s' is not tagged","EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/","scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return","scores = {} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut':","or without # modification, are permitted provided that the following conditions are met:","\"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter'","'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter","In some case, a metric and cohort have a connection # and could","\"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }]","= [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions,","OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY","# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR #","= self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort in","response as http from ..compat import reverse from ..mixins import MatrixMixin from ..models","scores.update({str(cohort): score}) return {\"scores\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix","def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def","hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all()","'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have a connection","meaning. This is an attempt at magic. \"\"\" likely_metric = None look =","cohorts, let's show individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts","matrix = self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric","expect the system will magically switch between both meaning. This is an attempt","{ \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": { \"slug\": \"all-questions\",","('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey","= %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score})","[] }] } \"\"\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin,","met: # # 1. Redistributions of source code must retain the above copyright","'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and","from an queryset # of `EditableFilter` to a queryset of `Account` ... cohorts","get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples**","survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json {","\"\" } responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\",","\"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class =","# notice, this list of conditions and the following disclaimer in the #","*args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey **Examples** .. code-block::","= { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} #","\"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer","'metric' in metric.tags, \\ \"filter '%s' is not tagged as a metric\" %","questions related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }]","def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to a ``Matrix`` derived from *cohort*.","{\"scores\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first()","a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\":","#pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request,","of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\":","request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else:","\"\\ \"/ (%d * %d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert","request, *args, **kwargs) def delete(self, request, *args, **kwargs): \"\"\" Deletes a fitler **Tags**:","\"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a","import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as http from","get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()),","**Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json {","LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND","data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey **Examples** .. code-block::","Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \"slug\":","and could have the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug'])","# and could have the same name. for cohort in val['cohorts']: likely_metric =","class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET","1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" },","LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR #","accounts\", \"predicates\": [] }] } .. code-block:: http POST /api/matrix/ { \"slug\": \"all\",","} Response: 201 CREATED { \"slug\": \"all\", \"title\": \"All accounts against all questions\",","THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE","pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if","if accounts is None: accounts = get_account_model().objects.all() scores = {} if metric: assert","class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for cohorts aganist a metric.","metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All","cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have a connection #","import PageNumberPagination from rest_framework import response as http from ..compat import reverse from","\"title\": \"All accounts\", \"predicates\": [] }] } Response: 201 CREATED { \"slug\": \"all\",","= get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None:","\"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs)","languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class","class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset(","put(self, request, *args, **kwargs): \"\"\" Updates a fitler **Tags**: survey **Examples** .. code-block::","\"\"\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A","}, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } \"\"\"","likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts:","get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered","= MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of","either mean a cohort or a metric and expect the system will magically","for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts =","the following disclaimer. # 2. Redistributions in binary form must reproduce the above","view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data):","public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result)","Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\":","} \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**:","for '%s' = (%d * 100) \"\\ \"/ (%d * %d) = %f\",","# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR","OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS","accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an","OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN","Note: switch cohorts from an queryset # of `EditableFilter` to a queryset of","AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT","and use in source and binary forms, with or without # modification, are","THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED","collections import OrderedDict from django.db.models import F from django.http import Http404 from django.shortcuts","\"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class = MatrixSerializer lookup_field =","Create a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds","def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request,","\"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args,","PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\",","survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\":","import reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from","\"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\",","MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**: ..","json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination serializer_class =","fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block::","self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey **Examples**","if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1])","\"\" ], \"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\":","conditions are met: # # 1. Redistributions of source code must retain the","import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class","self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort in cohorts:","MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores","\"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" search_fields =","accounts result = [] scores = {} val = { 'slug': metric.slug, 'title':","\"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self,","this list of conditions and the following disclaimer in the # documentation and/or","BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF","at magic. \"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try:","\"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer() class","# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED","USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY","attempt at magic. \"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look:","\"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return","\"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def","don't have any cohorts, let's show individual accounts instead. if cut: includes, excludes","MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response:","fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return","# override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return","if nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes","class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages","return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a","\"All questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\":","http GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts for all questions\"","accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument # will","Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer","list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \"slug\": \"all\",","except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix =","request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get(","disclaimer in the # documentation and/or other materials provided with the distribution. #","get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to a","scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores =","OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF","mean a cohort or a metric and expect the system will magically switch","slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of","WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND","import OrderedDict from django.db.models import F from django.http import Http404 from django.shortcuts import","is None`, the `cohorts` argument # will be a list of single account","to a queryset of `Account` ... cohorts = accounts result = [] scores","get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404(","QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response:","django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination","[{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } Response: 201 CREATED","= self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request,","cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores]","code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous:","all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class = MatrixSerializer","nb_accounts) LOGGER.debug(\"score for '%s' = (%d * 100) \"\\ \"/ (%d * %d)","Many times people will use the same name to either mean a cohort","\"All accounts\", \"predicates\": [] }] } Response: 201 CREATED { \"slug\": \"all\", \"title\":","public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)})","request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey **Examples** ..","copyright notice, # this list of conditions and the following disclaimer. # 2.","BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR","EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset,","\"\"\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: {","``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All","get_account_serializer() # Implementation Note: switch cohorts from an queryset # of `EditableFilter` to","switch between both meaning. This is an attempt at magic. \"\"\" likely_metric =","None: accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags,","= get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer =","public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod","cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts()","\"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } .. code-block:: http POST /api/matrix/","cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass","Redistribution and use in source and binary forms, with or without # modification,","} }] \"\"\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model","POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import OrderedDict from django.db.models","\"All accounts against all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\":","get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination","as http from ..compat import reverse from ..mixins import MatrixMixin from ..models import","else: # If `matrix.cohorts is None`, the `cohorts` argument # will be a","\"\"\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds","self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return","HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #","source and binary forms, with or without # modification, are permitted provided that","EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE","%d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort):","**Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts","above copyright # notice, this list of conditions and the following disclaimer in","get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\" Updates a fitler **Tags**:","score}) return {\"scores\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix =","request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next',","lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request,","# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,","THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\"","binary form must reproduce the above copyright # notice, this list of conditions","= self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut,","accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else:","{} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores]","form must reproduce the above copyright # notice, this list of conditions and","**kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args,","} \"\"\" pagination_class = EditableFilterPagination serializer_class = None # override in subclasses lookup_field","nb_questions = len(questions) if nb_questions > 0: for cohort in cohorts: if isinstance(cohort,","\"predicates\": [] }] } .. code-block:: http POST /api/matrix/ { \"slug\": \"all\", \"title\":","cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \"slug\":","cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts`","from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER =","get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to a ``Matrix`` derived from","of conditions and the following disclaimer. # 2. Redistributions in binary form must","def put(self, request, *args, **kwargs): \"\"\" Updates a fitler **Tags**: survey **Examples** ..","], \"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args,","\"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\"","= 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\" Updates","return {\"scores\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter(","EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers","is not tagged as a metric\" % str(metric) includes, excludes = metric.as_kwargs() questions","filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds ..","single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0:","= self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise",".. code-block:: json { \"count\": 2, previous: null, next: null, results: [ {","DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE","= MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self,","= self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an queryset","# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE)","a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds ..","serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table","`matrix.cohorts is None`, the `cohorts` argument # will be a list of single","to a ``Matrix`` derived from *cohort*. Many times people will use the same","'%s' is not tagged as a metric\" % str(metric) includes, excludes = metric.as_kwargs()","This is an attempt at magic. \"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\",","cohorts: # We don't have any cohorts, let's show individual accounts instead. if","{ \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\",","..compat import reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter","following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright","def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to","\"All accounts\", \"predicates\": [] }] } .. code-block:: http POST /api/matrix/ { \"slug\":","[cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter(","a cohort or a metric and expect the system will magically switch between","\"title\": \"All cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }]","def post(self, request, *args, **kwargs): \"\"\" Create a fitler **Tags**: survey **Examples** ..","(INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE","\"\" ], \"likely_metric\": \"\" } ] } \"\"\" search_fields = ['tags'] serializer_class =","**Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request,","* %d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100","IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR","USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH","cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores =","the above copyright # notice, this list of conditions and the following disclaimer","}] } \"\"\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView):","= nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' =","def delete(self, request, *args, **kwargs): \"\"\" Deletes a fitler **Tags**: survey **Examples** ..","cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\":","\"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset,","SUCH DAMAGE. import logging, re from collections import OrderedDict from django.db.models import F","accounts against all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": []","PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS","http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ]))","DjaoDjin inc. # All rights reserved. # # Redistribution and use in source","\\ \"filter '%s' is not tagged as a metric\" % str(metric) includes, excludes","result = [] scores = {} val = { 'slug': metric.slug, 'title': metric.title,","\"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field =","\"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug'","question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions * nb_accounts)","includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions","FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT","EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET","rest_framework.pagination import PageNumberPagination from rest_framework import response as http from ..compat import reverse","django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework","\"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of","= accounts result = [] scores = {} val = { 'slug': metric.slug,","metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case,","accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer(","\"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } responds","documentation and/or other materials provided with the distribution. # # THIS SOFTWARE IS","many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def","return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(),","`Account` ... cohorts = accounts result = [] scores = {} val =","cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\":","and the following disclaimer in the # documentation and/or other materials provided with","OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE","from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as","], \"likely_metric\": \"\" } ] } \"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer","\"All questions related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\"","MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for cohorts aganist a metric. **Examples**:",".. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2,","= EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def","*args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request,","*args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return","self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**: ..","A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER","\"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\":","forms, with or without # modification, are permitted provided that the following conditions","import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import","F from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin","of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts >","the `cohorts` argument # will be a list of single account objects. qs_accounts","generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for cohorts aganist a metric. **Examples**: ..","= len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score","``Matrix`` derived from *cohort*. Many times people will use the same name to","\"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" search_fields = ['tags']","CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY","= likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if","= 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument","a metric\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions","Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts","switch cohorts from an queryset # of `EditableFilter` to a queryset of `Account`","}, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } Response:","\"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] }","*args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else: parts","is an attempt at magic. \"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug)","\"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" search_fields = ['tags'] serializer_class","'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs):","conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce","request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self,","EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT,","\"title\": \"All accounts\", \"predicates\": [] }] } .. code-block:: http POST /api/matrix/ {","\"filter '%s' is not tagged as a metric\" % str(metric) includes, excludes =","and cohort have a connection # and could have the same name. for","try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def","self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg])","@property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix","in source and binary forms, with or without # modification, are permitted provided","HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT","nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count()","\"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\":","argument # will be a list of single account objects. qs_accounts = [cohort]","Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 ..","notice, # this list of conditions and the following disclaimer. # 2. Redistributions","THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import OrderedDict from","# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, #","\"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs)","\"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg","], \"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [","], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def","# # Redistribution and use in source and binary forms, with or without","connection # and could have the same name. for cohort in val['cohorts']: likely_metric","**Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json","[] scores = {} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric),","**Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView,","slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts","= logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http","\"slug\": \"languages\", \"title\": \"All questions related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\",","lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts,","\"languages\", \"title\": \"All cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", }","re from collections import OrderedDict from django.db.models import F from django.http import Http404","nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes =","* 100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' = (%d *","score <= 100 scores.update({str(cohort): score}) return {\"scores\": scores} @property def matrix(self): if not","cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an queryset # of","in the # documentation and/or other materials provided with the distribution. # #","nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\"scores\": scores}","metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores","if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric,","survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json {","INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT,","* 100) \"\\ \"/ (%d * %d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts,","any cohorts, let's show individual accounts instead. if cut: includes, excludes = cut.as_kwargs()","request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**: .. code-block::","OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR","= EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not","**kwargs): \"\"\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/","lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\"","# Implementation Note: switch cohorts from an queryset # of `EditableFilter` to a","= [] scores = {} val = { 'slug': metric.slug, 'title': metric.title, 'metric':","super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \"\"\" Deletes a","code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs)","EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES","BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR","NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF","= EditableFilterPagination serializer_class = None # override in subclasses lookup_field = 'slug' lookup_url_kwarg","DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED","nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\"scores\": scores} @property def","\"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put(","\"\", \"selector\": \"\" ], \"likely_metric\": \"\" } responds .. code-block:: json { \"slug\":","Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\":","0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 /","nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' = (%d * 100) \"\\ \"/ (%d","2020, DjaoDjin inc. # All rights reserved. # # Redistribution and use in","questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": []","\"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class = MatrixSerializer lookup_field = 'slug'","} \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve",".. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \"slug\": \"all\",","data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results',","http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class","from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from","{ \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\",","includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is","IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN","/api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All questions related to languages\" \"predicates\":[{ \"operator\":","not cohorts: # We don't have any cohorts, let's show individual accounts instead.","**Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\": \"all\",","matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut","Response: { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": { \"slug\":","Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer,","}, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } ..","# 1. Redistributions of source code must retain the above copyright notice, #","is None: accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric' in","\"All cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\"","rest_framework import response as http from ..compat import reverse from ..mixins import MatrixMixin","import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``.","\"\"\" pagination_class = EditableFilterPagination serializer_class = None # override in subclasses lookup_field =","\"\"\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model","COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,","= Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug):","HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous: null, next: null, results:","will use the same name to either mean a cohort or a metric","WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN","\"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\"","list of conditions and the following disclaimer. # 2. Redistributions in binary form","class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples** .. code-block:: http","FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE","# will be a list of single account objects. qs_accounts = [cohort] nb_accounts","return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples** ..","**kwargs): \"\"\" Create a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/","from *cohort*. Many times people will use the same name to either mean","= re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except","SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response","a URL to a ``Matrix`` derived from *cohort*. Many times people will use","\"title\": \"All questions related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\",","def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\" Updates a fitler","\"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request,","magically switch between both meaning. This is an attempt at magic. \"\"\" likely_metric","HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self,","= accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument #","\"slug\": \"languages\", \"title\": \"All cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\",","def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts =","\"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\":","use in source and binary forms, with or without # modification, are permitted","/api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous: null, next: null,","OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import OrderedDict","EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\" Updates a fitler **Tags**: survey **Examples**","in binary form must reproduce the above copyright # notice, this list of","\"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\":","= self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note:","= 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None,","http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\"","\"All accounts\", \"predicates\": [] }] } \"\"\" serializer_class = MatrixSerializer def get_queryset(self): return","for cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{","return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``.","\"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" search_fields","lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request,","CREATED { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": { \"slug\":","name to either mean a cohort or a metric and expect the system","\"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } responds .. code-block:: json {","THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import","# All rights reserved. # # Redistribution and use in source and binary","questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": [] }, \"cohorts\": [{","List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds ..","public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return","likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric","/api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts for all questions\" \"scores\":{ \"portfolio-a\":","tagged as a metric\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter(","excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`,","cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter(","1. Redistributions of source code must retain the above copyright notice, # this","metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric","PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,","self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self,","from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from","# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS","code-block:: http GET /api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All accounts against all","= (%d * 100) \"\\ \"/ (%d * %d) = %f\", str(cohort), nb_correct_answers,","a queryset of `Account` ... cohorts = accounts result = [] scores =","List filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds","\"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric =","\"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class","metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer","} ] } \"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request,","\"selector\": \"\" ], \"likely_metric\": \"\" } responds .. code-block:: json { \"slug\": \"all\",","nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / (","or a metric and expect the system will magically switch between both meaning.","POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous: null, next:","def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for","matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix","EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts","(%d * 100) \"\\ \"/ (%d * %d) = %f\", str(cohort), nb_correct_answers, nb_questions,","def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey","DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY","a metric and expect the system will magically switch between both meaning. This","post(self, request, *args, **kwargs): \"\"\" Create a fitler **Tags**: survey **Examples** .. code-block::","PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR","'%s' = (%d * 100) \"\\ \"/ (%d * %d) = %f\", str(cohort),","self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404()","#pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \"\"\"","case, a metric and cohort have a connection # and could have the","return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data)","# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;","import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import","POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": {","HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,","SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS","= Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions","self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {}","] } \"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args,","have any cohorts, let's show individual accounts instead. if cut: includes, excludes =","import response as http from ..compat import reverse from ..mixins import MatrixMixin from","super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey","qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter(","}] } .. code-block:: http POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts","} \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args,","a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds ..","} \"\"\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\"","def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric =","= self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first()","/api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": {","rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as http","override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all()","pagination_class = EditableFilterPagination serializer_class = None # override in subclasses lookup_field = 'slug'","from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from","%f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return","if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts =","from ..compat import reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix,","> 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs()","**Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\":","likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri(","people will use the same name to either mean a cohort or a","[public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin,","2. Redistributions in binary form must reproduce the above copyright # notice, this","must retain the above copyright notice, # this list of conditions and the","/ ( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' = (%d * 100) \"\\","result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class","= None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart',","of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \"slug\": \"all\", \"title\":","'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs):","ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF","aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \"slug\": \"languages\",","\"title\": \"All questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\",","a list of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if","], \"likely_metric\": \"\" } responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\",","self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView):","fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block::","cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if","matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self):","\"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation","GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\":","questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort","reproduce the above copyright # notice, this list of conditions and the following","excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer =","OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF","responds .. code-block:: json { \"count\": 2, previous: null, next: null, results: [","\"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\":","\"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" }, {","serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\" Create a fitler **Tags**:","'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\" Updates a","..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers","\"count\": 2, previous: null, next: null, results: [ { \"slug\": \"all\", \"title\": \"All\",","\"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs):","code-block:: http POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts against all questions\",","= 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if","self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter =","look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric","the above copyright notice, # this list of conditions and the following disclaimer.","both meaning. This is an attempt at magic. \"\"\" likely_metric = None look","return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \"\"\" Deletes","with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS","= generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\"","/api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\":","assert 'metric' in metric.tags, \\ \"filter '%s' is not tagged as a metric\"","and binary forms, with or without # modification, are permitted provided that the","if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts =","Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for cohorts aganist a","#pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL to a ``Matrix``","\"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView):","\"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\"","\"0.5\", } }] \"\"\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path'","cohort or a metric and expect the system will magically switch between both","#pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores = {} if metric:","DAMAGE. import logging, re from collections import OrderedDict from django.db.models import F from","return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView):","cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update(","nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers *","EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re","\"predicates\": [] }] } \"\"\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class","= get_account_serializer() # Implementation Note: switch cohorts from an queryset # of `EditableFilter`","'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a","{ \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination serializer_class = None","[{ \"slug\": \"languages\", \"title\": \"All cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\":","/api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\"","[{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } \"\"\" serializer_class =","EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**:","`cohorts` argument # will be a list of single account objects. qs_accounts =","responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [","OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON","following disclaimer in the # documentation and/or other materials provided with the distribution.","If `matrix.cohorts is None`, the `cohorts` argument # will be a list of","**kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else: parts =","related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] }","\"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination serializer_class = None # override in","from rest_framework.pagination import PageNumberPagination from rest_framework import response as http from ..compat import","/api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def","# this list of conditions and the following disclaimer. # 2. Redistributions in","\"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination serializer_class = None # override","**Examples**: .. code-block:: http GET /api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All accounts","http POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\":",".. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\": \"all\", \"title\":","PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS","ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE","} \"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs):","}] } Response: 201 CREATED { \"slug\": \"all\", \"title\": \"All accounts against all","AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response:","reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils","\"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\":","\"all-questions\", \"title\": \"All questions\", \"predicates\": [] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All","a ``Matrix`` derived from *cohort*. Many times people will use the same name","\"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } \"\"\" serializer_class = MatrixSerializer def","**kwargs): \"\"\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/","fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json","super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter","IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from","\"\", \"selector\": \"\" ], \"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\": \"None\", \"tags\":","FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT","['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\" Create a fitler","delete(self, request, *args, **kwargs): \"\"\" Deletes a fitler **Tags**: survey **Examples** .. code-block::","EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list","IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY","LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,","\"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: {","have a connection # and could have the same name. for cohort in","magic. \"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric","materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE","\"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered","return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**:","system will magically switch between both meaning. This is an attempt at magic.","201 CREATED { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": {","question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is","AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE","= matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't have any","<reponame>djaodjin/djaodjin-survey # Copyright (c) 2020, DjaoDjin inc. # All rights reserved. # #","of conditions and the following disclaimer in the # documentation and/or other materials","slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns","self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey **Examples**","\"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" }, { \"slug\":","not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return","EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix","\"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" }, { \"slug\": \"none\",","self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())})","= get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags, \\ \"filter","cohort have a connection # and could have the same name. for cohort","\"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return","isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If","'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some",".serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of","self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \"\"\" Returns a URL","\"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\"","metric\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions =","if not cohorts: # We don't have any cohorts, let's show individual accounts","\"\"\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1","None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=(","**includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument # will be","\"values\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset():","\"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView,","matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts =",".. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination","in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def","the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric']","serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block::","paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view)","100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s' = (%d * 100)","('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects","metric and cohort have a connection # and could have the same name.","} ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView):","qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument","ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT","between both meaning. This is an attempt at magic. \"\"\" likely_metric = None","cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() #","the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND","self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return","EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts:","json { \"count\": 2, previous: null, next: null, results: [ { \"slug\": \"all\",","matrix.cut if not cohorts: # We don't have any cohorts, let's show individual","that the following conditions are met: # # 1. Redistributions of source code","subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self,","\"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class = get_account_serializer()","objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers =","a metric and cohort have a connection # and could have the same","table of scores for cohorts aganist a metric. **Examples**: .. code-block:: http GET","same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] =","instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts","CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY,","disclaimer. # 2. Redistributions in binary form must reproduce the above copyright #","null, next: null, results: [ { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\":","from collections import OrderedDict from django.db.models import F from django.http import Http404 from","A table of scores for cohorts aganist a metric. **Examples**: .. code-block:: http","same name to either mean a cohort or a metric and expect the","questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class = MatrixSerializer lookup_field","objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block::","code must retain the above copyright notice, # this list of conditions and","``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All","CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT","BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN","GET /api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\":","str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\"scores\":","cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: #","the following conditions are met: # # 1. Redistributions of source code must","/api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\": { \"slug\":","IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY","scores = {} if metric: assert 'metric' in metric.tags, \\ \"filter '%s' is","else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not","next: null, results: [ { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [","request, *args, **kwargs): \"\"\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http","*args, **kwargs) def delete(self, request, *args, **kwargs): \"\"\" Deletes a fitler **Tags**: survey","THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE","fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block::","\"likely_metric\": \"\" } ] } \"\"\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def","be a list of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts)","def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous',","{ \"count\": 2, previous: null, next: null, results: [ { \"slug\": \"all\", \"title\":","INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS","[ { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\":","[ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\":","return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for cohorts aganist","EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/","EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have a","AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL","STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY","IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF #","[] }] } Response: 201 CREATED { \"slug\": \"all\", \"title\": \"All accounts against","if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return","ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT","}] \"\"\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model =","null, results: [ { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [ \"rank\":","} responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\":","\"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ]","self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \"\"\" Deletes a fitler","\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED #","metric: assert 'metric' in metric.tags, \\ \"filter '%s' is not tagged as a","\"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\" serializer_class =","django.db.models import F from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins","self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter","list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\",","the following disclaimer in the # documentation and/or other materials provided with the","return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation(","must reproduce the above copyright # notice, this list of conditions and the","import logging, re from collections import OrderedDict from django.db.models import F from django.http","serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all()","We don't have any cohorts, let's show individual accounts instead. if cut: includes,","SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,","to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\": \"text\", \"selector\":\"keepmatching\" }] } \"\"\"","2, previous: null, next: null, results: [ { \"slug\": \"all\", \"title\": \"All\", \"tags\":","\"\" ], \"likely_metric\": \"\" } responds .. code-block:: json { \"slug\": \"all\", \"title\":","GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts for all questions\" \"scores\":{","\"/ (%d * %d) = %f\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score","OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF","cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else:","if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: #","HTTP/1.1 .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\": \"\", \"predicates\": [","code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\":","0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts","**kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination,","an attempt at magic. \"\"\" likely_metric = None look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if","code-block:: json { \"count\": 2, previous: null, next: null, results: [ { \"slug\":","list of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts","OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.","**kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \"\"\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http","{} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts':","TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR","logging, re from collections import OrderedDict from django.db.models import F from django.http import","val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric,","[] }] } .. code-block:: http POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All","of `Account` ... cohorts = accounts result = [] scores = {} val","get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET","**Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All questions","1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" }","`EditableFilter` to a queryset of `Account` ... cohorts = accounts result = []","IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO,","Response: 201 CREATED { \"slug\": \"all\", \"title\": \"All accounts against all questions\", \"metric\":","the # documentation and/or other materials provided with the distribution. # # THIS","class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List","survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json {","\"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: {","EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\" Create a fitler **Tags**: survey **Examples**","len(questions) if nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes,","nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\"scores\": scores} @property","class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey **Examples** .. code-block:: http GET","raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut =","result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts,","@staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \"\"\" List fitlers **Tags**:","other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY","LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR","\"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } .. code-block:: http POST","list of conditions and the following disclaimer in the # documentation and/or other","in metric.tags, \\ \"filter '%s' is not tagged as a metric\" % str(metric)","= {} public_scores.update(val) public_scores.update( {\"cohorts\": EditableFilterSerializer( public_cohorts, many=True).data, \"values\": self.aggregate_scores(metric, public_cohorts)}) result +=","} .. code-block:: http POST /api/matrix/ { \"slug\": \"all\", \"title\": \"All accounts against","\"\" ], \"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request,","**Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json","GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 }","accounts\", \"predicates\": [] }] } Response: 201 CREATED { \"slug\": \"all\", \"title\": \"All","code-block:: http GET /api/matrix/languages Response: [{ \"slug\": \"languages\", \"title\": \"All cohorts for all","serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def","if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use","get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer","= 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args,","# Copyright (c) 2020, DjaoDjin inc. # All rights reserved. # # Redistribution","\"All\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\",","LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block::",".. code-block:: http GET /api/matrix/ Response: { \"slug\": \"all\", \"title\": \"All accounts against","``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All","SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED","from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import","cohorts from an queryset # of `EditableFilter` to a queryset of `Account` ...","[] }, \"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] }","get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView,","if metric: assert 'metric' in metric.tags, \\ \"filter '%s' is not tagged as","\"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } Response: 201 CREATED {","super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)),","= metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0:","a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation","\"\"\" Returns a URL to a ``Matrix`` derived from *cohort*. Many times people","the same name to either mean a cohort or a metric and expect","re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist:","as a metric\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes)","logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \"\"\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET","not tagged as a metric\" % str(metric) includes, excludes = metric.as_kwargs() questions =","reserved. # # Redistribution and use in source and binary forms, with or","return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix:","\"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } responds .. code-block:: json","# Redistribution and use in source and binary forms, with or without #","\"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg =","\"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post(","Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\"","get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \"\"\" A table of scores for cohorts","return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \"\"\" Updates a fitler **Tags**: survey","http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\":","metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val)","against all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All questions\", \"predicates\": [] },","cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores = {}","view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()),","Returns a URL to a ``Matrix`` derived from *cohort*. Many times people will","code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"count\": 2, previous:","EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER","{ \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\",","lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint:","public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all()","# We don't have any cohorts, let's show individual accounts instead. if cut:","\"selector\": \"\" ], \"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\",","= ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \"\"\" Create a","\"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class = EditableFilterPagination serializer_class = None #","self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if","look = re.match(r\"(\\S+)(-\\d+)\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,)))","are permitted provided that the following conditions are met: # # 1. Redistributions","generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered","\"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``. **Examples**: ..","generics.ListCreateAPIView): \"\"\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1","will magically switch between both meaning. This is an attempt at magic. \"\"\"","a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block::","survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete(","self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args,","ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING","NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,","derived from *cohort*. Many times people will use the same name to either","cohorts = accounts result = [] scores = {} val = { 'slug':","> 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100","GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION)",".. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\",","Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut","scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores","\"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } responds .. code-block::","list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\",","ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import","from rest_framework import response as http from ..compat import reverse from ..mixins import","**Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \"slug\":","account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers","binary forms, with or without # modification, are permitted provided that the following","\"\" }, { \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1,","% str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions)","times people will use the same name to either mean a cohort or","..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__)","OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY,","\"\"\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1","self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**:","# 2. Redistributions in binary form must reproduce the above copyright # notice,","('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List","None # override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self):","\"None\", \"tags\": \"\", \"predicates\": [ \"rank\": 1, \"operator\": \"\", \"operand\": \"\", \"field\": \"\",","distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS","**includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort in cohorts: if","import F from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import","\"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } \"\"\" serializer_class","Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds","\"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } responds ..","WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING","*args, **kwargs): \"\"\" Create a fitler **Tags**: survey **Examples** .. code-block:: http POST","# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF","\"all\", \"title\": \"All accounts against all questions\", \"metric\": { \"slug\": \"all-questions\", \"title\": \"All","self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch","\"languages\", \"title\": \"All questions related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\": \"language\", \"field\":","LOGGER.debug(\"score for '%s' = (%d * 100) \"\\ \"/ (%d * %d) =","# # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS #","}] } \"\"\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``Question``.","metric and expect the system will magically switch between both meaning. This is","# In some case, a metric and cohort have a connection # and","MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer)","metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for","\"likely_metric\": \"\" } responds .. code-block:: json { \"slug\": \"all\", \"title\": \"All\", \"tags\":","of scores for cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages","('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class","**Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \"created_at\":","and expect the system will magically switch between both meaning. This is an","code-block:: http GET /api/questions/languages Response: { \"slug\": \"languages\", \"title\": \"All questions related to","OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO","to either mean a cohort or a metric and expect the system will","\"likely_metric\": \"\" }, { \"slug\": \"none\", \"title\": \"None\", \"tags\": \"\", \"predicates\": [ \"rank\":","if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\"values\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result","cohorts for all questions\" \"scores\":{ \"portfolio-a\": \"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class","parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix:","HTTP/1.1 responds .. code-block:: json { \"created_at\": \"2020-01-01T00:00:00Z\", \"measured\": 12 } \"\"\" pagination_class","includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer","(c) 2020, DjaoDjin inc. # All rights reserved. # # Redistribution and use","queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def","def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return","individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes)","request, *args, **kwargs): \"\"\" Create a fitler **Tags**: survey **Examples** .. code-block:: http","public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't have","else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from","OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS","\"0.1\", \"portfolio-b\": \"0.5\", } }] \"\"\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg","INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,","= None # override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def","# modification, are permitted provided that the following conditions are met: # #","cut = matrix.cut if not cohorts: # We don't have any cohorts, let's","\"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return","score = nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\"score for '%s'","BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES","\"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\" serializer_class = EditableFilterSerializer lookup_field","{ \"slug\": \"languages\", \"title\": \"All questions related to languages\" \"predicates\":[{ \"operator\": \"contains\", \"operand\":","\"\", \"selector\": \"\" ], \"likely_metric\": \"\" } ] } \"\"\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView,","source code must retain the above copyright notice, # this list of conditions","('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey **Examples** ..","class AccountListAPIView(EditableFilterObjectsAPIView): \"\"\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages","copyright # notice, this list of conditions and the following disclaimer in the","self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an queryset #","matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't have any cohorts,","above copyright notice, # this list of conditions and the following disclaimer. #","len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score =","\"cohorts\": [{ \"slug\": \"all-accounts\", \"title\": \"All accounts\", \"predicates\": [] }] } .. code-block::","])) class EditableFilterObjectsAPIView(generics.ListAPIView): \"\"\" List filter objects **Tags**: survey **Examples** .. code-block:: http","self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count',"],"string":"[\n \"\\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\"\",\n \"TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE\",\n \"'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have\",\n \"[{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } .. code-block:: http\",\n \"\\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation\",\n \"the system will magically switch between both meaning. This is an attempt at\",\n \"http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\"\",\n \"return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to a ``Matrix`` derived\",\n \"self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter,\",\n \"accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags, \\\\\",\n \"import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import\",\n \"SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT\",\n \"this list of conditions and the following disclaimer. # 2. Redistributions in binary\",\n \"'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts\",\n \".. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related\",\n \"\\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer\",\n \"= len(questions) if nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter):\",\n \"def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter =\",\n \"without # modification, are permitted provided that the following conditions are met: #\",\n \"**includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts\",\n \"request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http\",\n \"(get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView):\",\n \"likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self,\",\n \"code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\",\",\n \"\\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request,\",\n \"All rights reserved. # # Redistribution and use in source and binary forms,\",\n \"EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix\",\n \"= matrix.cut if not cohorts: # We don't have any cohorts, let's show\",\n \"\\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_question_serializer()\",\n \"import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer,\",\n \"get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts\",\n \"retain the above copyright notice, # this list of conditions and the following\",\n \"= view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([\",\n \"if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers\",\n \"\\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\":\",\n \"scores for cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response:\",\n \"[scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\":\",\n \"EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self,\",\n \"**kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples**\",\n \"IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED.\",\n \"\\\"\\\"\\\" List filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1\",\n \"cohort_slug): \\\"\\\"\\\" Returns a URL to a ``Matrix`` derived from *cohort*. Many times\",\n \"#pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler\",\n \".. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args,\",\n \"metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix =\",\n \"\\\"\\\" } ] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self,\",\n \"and the following disclaimer. # 2. Redistributions in binary form must reproduce the\",\n \"THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF\",\n \"\\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } Response: 201\",\n \"..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model,\",\n \"queryset of `Account` ... cohorts = accounts result = [] scores = {}\",\n \"name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric\",\n \"LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\",\n \"#pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs)\",\n \"LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT\",\n \"let's show individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts =\",\n \"accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores = {} if\",\n \"\\\"predicates\\\": [] }] } Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts\",\n \"likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result +=\",\n \"json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\":\",\n \"provided that the following conditions are met: # # 1. Redistributions of source\",\n \"12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None # override in subclasses\",\n \"for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val)\",\n \"from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from\",\n \"100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def matrix(self): if not hasattr(self, '_matrix'):\",\n \"an queryset # of `EditableFilter` to a queryset of `Account` ... cohorts =\",\n \"likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts,\",\n \"some case, a metric and cohort have a connection # and could have\",\n \"queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count),\",\n \"\\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1\",\n \"= self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric =\",\n \"are met: # # 1. Redistributions of source code must retain the above\",\n \"\\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\",\",\n \"OF SUCH DAMAGE. import logging, re from collections import OrderedDict from django.db.models import\",\n \"\\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\":\",\n \"conditions and the following disclaimer in the # documentation and/or other materials provided\",\n \"/api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\",\",\n \"], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg =\",\n \".. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2,\",\n \"responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class =\",\n \"and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED\",\n \"* nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d * 100) \\\"\\\\ \\\"/ (%d *\",\n \"\\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class\",\n \"of `EditableFilter` to a queryset of `Account` ... cohorts = accounts result =\",\n \"EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples** .. code-block::\",\n \"{\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class\",\n \"self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\"\",\n \"matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't\",\n \"permitted provided that the following conditions are met: # # 1. Redistributions of\",\n \"EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object):\",\n \"extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework\",\n \"accounts is None: accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric'\",\n \"TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE\",\n \"WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF\",\n \"{ 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In\",\n \"\\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ],\",\n \"super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**:\",\n \"NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\",\n \"notice, this list of conditions and the following disclaimer in the # documentation\",\n \"= matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We\",\n \"# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections\",\n \"+= [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin,\",\n \"http from ..compat import reverse from ..mixins import MatrixMixin from ..models import Answer,\",\n \"EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView):\",\n \"results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1,\",\n \"DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination):\",\n \"view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter',\",\n \"all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\":\",\n \"lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals\",\n \"code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None):\",\n \"http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12\",\n \"http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\",\",\n \"nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d\",\n \"public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result\",\n \"sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score\",\n \"AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR\",\n \"class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/\",\n \"*args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http\",\n \"will be a list of single account objects. qs_accounts = [cohort] nb_accounts =\",\n \"\\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } Response: 201 CREATED { \\\"slug\\\":\",\n \"with or without # modification, are permitted provided that the following conditions are\",\n \"INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, #\",\n \"assert score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def matrix(self): if\",\n \"\\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\",\",\n \"http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\",\",\n \"code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1,\",\n \".. code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for\",\n \"EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort\",\n \"not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate')\",\n \"measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for\",\n \"*args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE\",\n \"in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores(\",\n \"request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter\",\n \"NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY\",\n \"OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER\",\n \"Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics\",\n \"*cohort*. Many times people will use the same name to either mean a\",\n \"OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER\",\n \"#pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/')\",\n \"excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions >\",\n \"HTTP/1.1 responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\":\",\n \"following conditions are met: # # 1. Redistributions of source code must retain\",\n \"metric.tags, \\\\ \\\"filter '%s' is not tagged as a metric\\\" % str(metric) includes,\",\n \"# # 1. Redistributions of source code must retain the above copyright notice,\",\n \"MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT\",\n \"serializer_class = None # override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter'\",\n \"\\\"\\\"\\\" A table of scores for cohorts aganist a metric. **Examples**: .. code-block::\",\n \"OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\",\n \"ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED\",\n \"= Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate')\",\n \"( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d * 100) \\\"\\\\ \\\"/\",\n \"Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\",\",\n \"previous: null, next: null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\",\",\n \"Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\"\",\n \"100) \\\"\\\\ \\\"/ (%d * %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score)\",\n \"in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes)\",\n \"code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class\",\n \"Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions *\",\n \"modification, are permitted provided that the following conditions are met: # # 1.\",\n \"= {} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut),\",\n \"from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list\",\n \"# of `EditableFilter` to a queryset of `Account` ... cohorts = accounts result\",\n \"= cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer()\",\n \"EditableFilterPagination serializer_class = None # override in subclasses lookup_field = 'slug' lookup_url_kwarg =\",\n \"... cohorts = accounts result = [] scores = {} val = {\",\n \"# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR #\",\n \"search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create\",\n \"CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL\",\n \"# documentation and/or other materials provided with the distribution. # # THIS SOFTWARE\",\n \"= 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args,\",\n \"for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class =\",\n \"ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED\",\n \"rights reserved. # # Redistribution and use in source and binary forms, with\",\n \"import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import\",\n \"(%d * %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <=\",\n \"+= [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data,\",\n \"\\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\",\",\n \"could have the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if\",\n \".. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\":\",\n \"**kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET\",\n \".. code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all\",\n \"a connection # and could have the same name. for cohort in val['cohorts']:\",\n \"show individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter(\",\n \"provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT\",\n \"Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\",\",\n \"Redistributions in binary form must reproduce the above copyright # notice, this list\",\n \"score) assert score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def matrix(self):\",\n \"\\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list\",\n \"# If `matrix.cohorts is None`, the `cohorts` argument # will be a list\",\n \"use the same name to either mean a cohort or a metric and\",\n \"Implementation Note: switch cohorts from an queryset # of `EditableFilter` to a queryset\",\n \"queryset # of `EditableFilter` to a queryset of `Account` ... cohorts = accounts\",\n \"args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals\",\n \"get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\"\",\n \"CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR\",\n \"*args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT\",\n \"Copyright (c) 2020, DjaoDjin inc. # All rights reserved. # # Redistribution and\",\n \"get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags, \\\\ \\\"filter '%s'\",\n \"accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation\",\n \"\\\"\\\"\\\" Create a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1\",\n \"str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if\",\n \"}, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\":\",\n \"reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs):\",\n \"val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)}\",\n \"inc. # All rights reserved. # # Redistribution and use in source and\",\n \"aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all()\",\n \"\\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\":\",\n \"} \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self):\",\n \"of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\":\",\n \"None`, the `cohorts` argument # will be a list of single account objects.\",\n \"= EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey\",\n \"http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous: null,\",\n \"\\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\"\",\n \"(INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS\",\n \"SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging,\",\n \"'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None):\",\n \"MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric,\",\n \"get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to a ``Matrix`` derived from *cohort*. Many\",\n \"http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous: null,\",\n \"have the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric:\",\n \"OrderedDict from django.db.models import F from django.http import Http404 from django.shortcuts import get_object_or_404\",\n \"EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/\",\n \"of source code must retain the above copyright notice, # this list of\",\n \"'_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def\",\n \"**Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json\",\n \"= get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http\",\n \"= {} if metric: assert 'metric' in metric.tags, \\\\ \\\"filter '%s' is not\",\n \"SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND\",\n \"<= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def matrix(self): if not hasattr(self,\",\n \"GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{\",\n \"= cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the\",\n \"disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class\",\n \"accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all()\",\n \"**Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\":\",\n \"\\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self):\",\n \"Redistributions of source code must retain the above copyright notice, # this list\",\n \"GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous: null, next:\",\n \"] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\"\",\n \"THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\",\n \"get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric\",\n \"from django.db.models import F from django.http import Http404 from django.shortcuts import get_object_or_404 from\",\n \"PageNumberPagination from rest_framework import response as http from ..compat import reverse from ..mixins\",\n \"URL to a ``Matrix`` derived from *cohort*. Many times people will use the\",\n \"PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; #\",\n \"DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\",\n \"generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as http from ..compat\",\n \"COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES,\",\n \"{} if metric: assert 'metric' in metric.tags, \\\\ \\\"filter '%s' is not tagged\",\n \"EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/\",\n \"scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return\",\n \"scores = {} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut':\",\n \"or without # modification, are permitted provided that the following conditions are met:\",\n \"\\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter'\",\n \"'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter\",\n \"In some case, a metric and cohort have a connection # and could\",\n \"\\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }]\",\n \"= [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions,\",\n \"OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY\",\n \"# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR #\",\n \"= self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort in\",\n \"response as http from ..compat import reverse from ..mixins import MatrixMixin from ..models\",\n \"scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix\",\n \"def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def\",\n \"hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all()\",\n \"'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have a connection\",\n \"meaning. This is an attempt at magic. \\\"\\\"\\\" likely_metric = None look =\",\n \"cohorts, let's show individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts\",\n \"matrix = self.matrix if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric\",\n \"expect the system will magically switch between both meaning. This is an attempt\",\n \"{ \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\",\",\n \"('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey\",\n \"= %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score})\",\n \"[] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin,\",\n \"met: # # 1. Redistributions of source code must retain the above copyright\",\n \"'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and\",\n \"from an queryset # of `EditableFilter` to a queryset of `Account` ... cohorts\",\n \"get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples**\",\n \"survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json {\",\n \"\\\"\\\" } responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\",\",\n \"\\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class =\",\n \"# notice, this list of conditions and the following disclaimer in the #\",\n \"*args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples** .. code-block::\",\n \"= { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} #\",\n \"\\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer\",\n \"'metric' in metric.tags, \\\\ \\\"filter '%s' is not tagged as a metric\\\" %\",\n \"questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }]\",\n \"def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to a ``Matrix`` derived from *cohort*.\",\n \"{\\\"scores\\\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first()\",\n \"a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\":\",\n \"#pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request,\",\n \"of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\":\",\n \"request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else:\",\n \"\\\"\\\\ \\\"/ (%d * %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert\",\n \"request, *args, **kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**:\",\n \"\\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a\",\n \"import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as http from\",\n \"get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()),\",\n \"**Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json {\",\n \"LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\",\n \"data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey **Examples** .. code-block::\",\n \"Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \\\"slug\\\":\",\n \"and could have the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug'])\",\n \"# and could have the same name. for cohort in val['cohorts']: likely_metric =\",\n \"class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET\",\n \"1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" },\",\n \"LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR #\",\n \"accounts\\\", \\\"predicates\\\": [] }] } .. code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\",\",\n \"} Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\",\",\n \"THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE\",\n \"pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if\",\n \"if accounts is None: accounts = get_account_model().objects.all() scores = {} if metric: assert\",\n \"class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for cohorts aganist a metric.\",\n \"metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All\",\n \"cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have a connection #\",\n \"import PageNumberPagination from rest_framework import response as http from ..compat import reverse from\",\n \"\\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } Response: 201 CREATED { \\\"slug\\\": \\\"all\\\",\",\n \"= get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None:\",\n \"\\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs)\",\n \"languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class\",\n \"class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset(\",\n \"put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples** .. code-block::\",\n \"\\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A\",\n \"}, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\"\",\n \"likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts:\",\n \"get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered\",\n \"= MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of\",\n \"either mean a cohort or a metric and expect the system will magically\",\n \"for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts =\",\n \"the following disclaimer. # 2. Redistributions in binary form must reproduce the above\",\n \"view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data):\",\n \"public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result)\",\n \"Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\":\",\n \"} \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**:\",\n \"for '%s' = (%d * 100) \\\"\\\\ \\\"/ (%d * %d) = %f\\\",\",\n \"# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR\",\n \"OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\",\n \"accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an\",\n \"OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN\",\n \"Note: switch cohorts from an queryset # of `EditableFilter` to a queryset of\",\n \"AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT\",\n \"and use in source and binary forms, with or without # modification, are\",\n \"THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED\",\n \"collections import OrderedDict from django.db.models import F from django.http import Http404 from django.shortcuts\",\n \"\\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field =\",\n \"Create a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds\",\n \"def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request,\",\n \"\\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args,\",\n \"PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\",\",\n \"survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\":\",\n \"import reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from\",\n \"\\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\",\",\n \"MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: ..\",\n \"json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class =\",\n \"fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block::\",\n \"self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey **Examples**\",\n \"if matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1])\",\n \"\\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\":\",\n \"conditions are met: # # 1. Redistributions of source code must retain the\",\n \"import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class\",\n \"self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort in cohorts:\",\n \"MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores\",\n \"\\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields =\",\n \"accounts result = [] scores = {} val = { 'slug': metric.slug, 'title':\",\n \"\\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self,\",\n \"this list of conditions and the following disclaimer in the # documentation and/or\",\n \"BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF\",\n \"at magic. \\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try:\",\n \"\\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer() class\",\n \"# \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED\",\n \"USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\",\n \"attempt at magic. \\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look:\",\n \"\\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return\",\n \"\\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def\",\n \"don't have any cohorts, let's show individual accounts instead. if cut: includes, excludes\",\n \"MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response:\",\n \"fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return\",\n \"# override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return\",\n \"if nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes\",\n \"class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages\",\n \"return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a\",\n \"\\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\":\",\n \"http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\"\",\n \"accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument # will\",\n \"Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer\",\n \"list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\",\",\n \"except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix =\",\n \"request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get(\",\n \"disclaimer in the # documentation and/or other materials provided with the distribution. #\",\n \"get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to a\",\n \"scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores =\",\n \"OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\",\n \"mean a cohort or a metric and expect the system will magically switch\",\n \"slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of\",\n \"WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND\",\n \"import OrderedDict from django.db.models import F from django.http import Http404 from django.shortcuts import\",\n \"is None`, the `cohorts` argument # will be a list of single account\",\n \"to a queryset of `Account` ... cohorts = accounts result = [] scores\",\n \"get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404(\",\n \"QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response:\",\n \"django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination\",\n \"[{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } Response: 201 CREATED\",\n \"= self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request,\",\n \"cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores]\",\n \"code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous:\",\n \"all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer\",\n \"nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d * 100) \\\"\\\\ \\\"/ (%d * %d)\",\n \"Many times people will use the same name to either mean a cohort\",\n \"\\\"All accounts\\\", \\\"predicates\\\": [] }] } Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)})\",\n \"request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples** ..\",\n \"copyright notice, # this list of conditions and the following disclaimer. # 2.\",\n \"BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\",\n \"EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset,\",\n \"\\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: {\",\n \"``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\",\n \"get_account_serializer() # Implementation Note: switch cohorts from an queryset # of `EditableFilter` to\",\n \"switch between both meaning. This is an attempt at magic. \\\"\\\"\\\" likely_metric =\",\n \"None: accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags,\",\n \"= get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer =\",\n \"public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod\",\n \"cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts()\",\n \"\\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } .. code-block:: http POST /api/matrix/\",\n \"cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass\",\n \"Redistribution and use in source and binary forms, with or without # modification,\",\n \"} }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model\",\n \"POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import OrderedDict from django.db.models\",\n \"\\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\":\",\n \"get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination\",\n \"as http from ..compat import reverse from ..mixins import MatrixMixin from ..models import\",\n \"else: # If `matrix.cohorts is None`, the `cohorts` argument # will be a\",\n \"\\\"\\\"\\\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds\",\n \"self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return\",\n \"HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #\",\n \"source and binary forms, with or without # modification, are permitted provided that\",\n \"EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE\",\n \"%d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort):\",\n \"**Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts\",\n \"above copyright # notice, this list of conditions and the following disclaimer in\",\n \"get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**:\",\n \"score}) return {\\\"scores\\\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix =\",\n \"request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next',\",\n \"lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request,\",\n \"# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\",\n \"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\"\",\n \"binary form must reproduce the above copyright # notice, this list of conditions\",\n \"= self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut,\",\n \"accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else:\",\n \"{} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores]\",\n \"form must reproduce the above copyright # notice, this list of conditions and\",\n \"**kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args,\",\n \"} \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None # override in subclasses lookup_field\",\n \"nb_questions = len(questions) if nb_questions > 0: for cohort in cohorts: if isinstance(cohort,\",\n \"\\\"predicates\\\": [] }] } .. code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\":\",\n \"cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts`\",\n \"from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER =\",\n \"get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to a ``Matrix`` derived from\",\n \"of conditions and the following disclaimer. # 2. Redistributions in binary form must\",\n \"def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples** ..\",\n \"], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args,\",\n \"\\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\"\",\n \"= 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates\",\n \"return {\\\"scores\\\": scores} @property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter(\",\n \"EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers\",\n \"is not tagged as a metric\\\" % str(metric) includes, excludes = metric.as_kwargs() questions\",\n \"filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds ..\",\n \"single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0:\",\n \"= self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise\",\n \".. code-block:: json { \\\"count\\\": 2, previous: null, next: null, results: [ {\",\n \"DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE\",\n \"= MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self,\",\n \"= self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an queryset\",\n \"# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE)\",\n \"a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds ..\",\n \"serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table\",\n \"`matrix.cohorts is None`, the `cohorts` argument # will be a list of single\",\n \"to a ``Matrix`` derived from *cohort*. Many times people will use the same\",\n \"'%s' is not tagged as a metric\\\" % str(metric) includes, excludes = metric.as_kwargs()\",\n \"This is an attempt at magic. \\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\",\",\n \"cohorts: # We don't have any cohorts, let's show individual accounts instead. if\",\n \"{ \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\",\",\n \"..compat import reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter\",\n \"following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright\",\n \"def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to\",\n \"\\\"All accounts\\\", \\\"predicates\\\": [] }] } .. code-block:: http POST /api/matrix/ { \\\"slug\\\":\",\n \"[cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter(\",\n \"a cohort or a metric and expect the system will magically switch between\",\n \"\\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }]\",\n \"def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey **Examples** ..\",\n \"(INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\",\n \"\\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class =\",\n \"**Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request,\",\n \"* %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100\",\n \"IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR\",\n \"USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH\",\n \"cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores =\",\n \"the above copyright # notice, this list of conditions and the following disclaimer\",\n \"}] } \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView):\",\n \"= nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' =\",\n \"def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples** ..\",\n \"cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\":\",\n \"\\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset,\",\n \"SUCH DAMAGE. import logging, re from collections import OrderedDict from django.db.models import F\",\n \"accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": []\",\n \"PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS\",\n \"http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ]))\",\n \"DjaoDjin inc. # All rights reserved. # # Redistribution and use in source\",\n \"\\\\ \\\"filter '%s' is not tagged as a metric\\\" % str(metric) includes, excludes\",\n \"result = [] scores = {} val = { 'slug': metric.slug, 'title': metric.title,\",\n \"\\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field =\",\n \"\\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug'\",\n \"question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions * nb_accounts)\",\n \"includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions\",\n \"FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\",\n \"EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET\",\n \"rest_framework.pagination import PageNumberPagination from rest_framework import response as http from ..compat import reverse\",\n \"django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework\",\n \"\\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of\",\n \"= accounts result = [] scores = {} val = { 'slug': metric.slug,\",\n \"metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case,\",\n \"accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer(\",\n \"\\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds\",\n \"documentation and/or other materials provided with the distribution. # # THIS SOFTWARE IS\",\n \"many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def\",\n \"return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(),\",\n \"`Account` ... cohorts = accounts result = [] scores = {} val =\",\n \"cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\":\",\n \"and the following disclaimer in the # documentation and/or other materials provided with\",\n \"OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE\",\n \"from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as\",\n \"], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer\",\n \"\\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\"\",\n \"MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for cohorts aganist a metric. **Examples**:\",\n \".. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2,\",\n \"= EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def\",\n \"*args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request,\",\n \"*args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return\",\n \"self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: ..\",\n \"A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER\",\n \"\\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\":\",\n \"forms, with or without # modification, are permitted provided that the following conditions\",\n \"import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import\",\n \"F from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin\",\n \"of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts >\",\n \"the `cohorts` argument # will be a list of single account objects. qs_accounts\",\n \"generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for cohorts aganist a metric. **Examples**: ..\",\n \"= len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score\",\n \"``Matrix`` derived from *cohort*. Many times people will use the same name to\",\n \"\\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields = ['tags']\",\n \"CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY\",\n \"= likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if\",\n \"= 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument\",\n \"a metric\\\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions\",\n \"Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts\",\n \"switch cohorts from an queryset # of `EditableFilter` to a queryset of `Account`\",\n \"}, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } Response:\",\n \"\\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] }\",\n \"*args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else: parts\",\n \"is an attempt at magic. \\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug)\",\n \"\\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class\",\n \"'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs):\",\n \"conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce\",\n \"request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self,\",\n \"EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\",\n \"\\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } .. code-block:: http POST /api/matrix/ {\",\n \"\\\"filter '%s' is not tagged as a metric\\\" % str(metric) includes, excludes =\",\n \"and cohort have a connection # and could have the same name. for\",\n \"try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def\",\n \"self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg])\",\n \"@property def matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix\",\n \"in source and binary forms, with or without # modification, are permitted provided\",\n \"HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT\",\n \"nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count()\",\n \"\\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\":\",\n \"argument # will be a list of single account objects. qs_accounts = [cohort]\",\n \"Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 ..\",\n \"notice, # this list of conditions and the following disclaimer. # 2. Redistributions\",\n \"THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import OrderedDict from\",\n \"# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, #\",\n \"\\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs)\",\n \"\\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg\",\n \"], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [\",\n \"], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def\",\n \"# # Redistribution and use in source and binary forms, with or without\",\n \"connection # and could have the same name. for cohort in val['cohorts']: likely_metric\",\n \"**Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json\",\n \"[] scores = {} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric),\",\n \"**Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView,\",\n \"slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts\",\n \"= logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http\",\n \"\\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\",\",\n \"lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts,\",\n \"\\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", }\",\n \"re from collections import OrderedDict from django.db.models import F from django.http import Http404\",\n \"nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes =\",\n \"* 100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d *\",\n \"score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def matrix(self): if not\",\n \"cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an queryset # of\",\n \"in the # documentation and/or other materials provided with the distribution. # #\",\n \"nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores}\",\n \"metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores\",\n \"if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric,\",\n \"survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json {\",\n \"INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT,\",\n \"* 100) \\\"\\\\ \\\"/ (%d * %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts,\",\n \"any cohorts, let's show individual accounts instead. if cut: includes, excludes = cut.as_kwargs()\",\n \"request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: .. code-block::\",\n \"OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR\",\n \"= EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not\",\n \"**kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/\",\n \"lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\"\",\n \"# Implementation Note: switch cohorts from an queryset # of `EditableFilter` to a\",\n \"= [] scores = {} val = { 'slug': metric.slug, 'title': metric.title, 'metric':\",\n \"super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a\",\n \"code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs)\",\n \"EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES\",\n \"BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR\",\n \"NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\",\n \"= EditableFilterPagination serializer_class = None # override in subclasses lookup_field = 'slug' lookup_url_kwarg\",\n \"DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\",\n \"nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property def\",\n \"\\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put(\",\n \"\\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json { \\\"slug\\\":\",\n \"Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\":\",\n \"0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 /\",\n \"nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d * 100) \\\"\\\\ \\\"/ (%d\",\n \"2020, DjaoDjin inc. # All rights reserved. # # Redistribution and use in\",\n \"questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": []\",\n \"\\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug'\",\n \"} \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve\",\n \".. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \\\"slug\\\": \\\"all\\\",\",\n \"data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results',\",\n \"http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class\",\n \"from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from\",\n \"{ \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\",\",\n \"includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is\",\n \"IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN\",\n \"/api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\":\",\n \"not cohorts: # We don't have any cohorts, let's show individual accounts instead.\",\n \"**Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\",\",\n \"matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut\",\n \"Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\":\",\n \"Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer,\",\n \"}, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } ..\",\n \"# 1. Redistributions of source code must retain the above copyright notice, #\",\n \"is None: accounts = get_account_model().objects.all() scores = {} if metric: assert 'metric' in\",\n \"\\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\"\",\n \"rest_framework import response as http from ..compat import reverse from ..mixins import MatrixMixin\",\n \"import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``.\",\n \"\\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None # override in subclasses lookup_field =\",\n \"\\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model\",\n \"COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\",\n \"= Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug):\",\n \"HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous: null, next: null, results:\",\n \"will use the same name to either mean a cohort or a metric\",\n \"WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN\",\n \"\\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\"\",\n \"list of conditions and the following disclaimer. # 2. Redistributions in binary form\",\n \"class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples** .. code-block:: http\",\n \"FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\",\n \"# will be a list of single account objects. qs_accounts = [cohort] nb_accounts\",\n \"return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples** ..\",\n \"**kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/\",\n \"from *cohort*. Many times people will use the same name to either mean\",\n \"= re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except\",\n \"SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response\",\n \"a URL to a ``Matrix`` derived from *cohort*. Many times people will use\",\n \"\\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\",\",\n \"def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler\",\n \"\\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request,\",\n \"magically switch between both meaning. This is an attempt at magic. \\\"\\\"\\\" likely_metric\",\n \"HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self,\",\n \"= accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument #\",\n \"\\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\",\",\n \"def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts =\",\n \"\\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\":\",\n \"use in source and binary forms, with or without # modification, are permitted\",\n \"/api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous: null, next: null,\",\n \"OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import OrderedDict\",\n \"EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples**\",\n \"in binary form must reproduce the above copyright # notice, this list of\",\n \"\\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\":\",\n \"= self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note:\",\n \"= 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None,\",\n \"http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\"\",\n \"\\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return\",\n \"for cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{\",\n \"return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``.\",\n \"\\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields\",\n \"lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request,\",\n \"CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\":\",\n \"name to either mean a cohort or a metric and expect the system\",\n \"\\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json {\",\n \"THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import\",\n \"# All rights reserved. # # Redistribution and use in source and binary\",\n \"questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{\",\n \"List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds ..\",\n \"public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return\",\n \"likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric\",\n \"/api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\":\",\n \"tagged as a metric\\\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter(\",\n \"excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`,\",\n \"cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter(\",\n \"1. Redistributions of source code must retain the above copyright notice, # this\",\n \"metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric\",\n \"PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\",\n \"self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self,\",\n \"from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import SearchableListMixin from\",\n \"# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS\",\n \"code-block:: http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all\",\n \"= (%d * 100) \\\"\\\\ \\\"/ (%d * %d) = %f\\\", str(cohort), nb_correct_answers,\",\n \"a queryset of `Account` ... cohorts = accounts result = [] scores =\",\n \"List filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds\",\n \"\\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric =\",\n \"\\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class\",\n \"metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer\",\n \"} ] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request,\",\n \"\\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json { \\\"slug\\\": \\\"all\\\",\",\n \"nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / (\",\n \"or a metric and expect the system will magically switch between both meaning.\",\n \"POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous: null, next:\",\n \"def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for\",\n \"matrix: metric = self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix\",\n \"EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts\",\n \"(%d * 100) \\\"\\\\ \\\"/ (%d * %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions,\",\n \"def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey\",\n \"DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\",\n \"a metric and expect the system will magically switch between both meaning. This\",\n \"post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey **Examples** .. code-block::\",\n \"PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR\",\n \"'%s' = (%d * 100) \\\"\\\\ \\\"/ (%d * %d) = %f\\\", str(cohort),\",\n \"self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404()\",\n \"#pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\"\",\n \"case, a metric and cohort have a connection # and could have the\",\n \"return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data)\",\n \"# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;\",\n \"import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import\",\n \"POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": {\",\n \"HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\",\n \"SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS\",\n \"= Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100 / ( nb_questions\",\n \"self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {}\",\n \"] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args,\",\n \"have any cohorts, let's show individual accounts instead. if cut: includes, excludes =\",\n \"import response as http from ..compat import reverse from ..mixins import MatrixMixin from\",\n \"super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey\",\n \"qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter(\",\n \"}] } .. code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts\",\n \"} \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args,\",\n \"a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds ..\",\n \"} \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\"\",\n \"def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric =\",\n \"= self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first()\",\n \"/api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": {\",\n \"rest_framework import generics from rest_framework.pagination import PageNumberPagination from rest_framework import response as http\",\n \"override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all()\",\n \"pagination_class = EditableFilterPagination serializer_class = None # override in subclasses lookup_field = 'slug'\",\n \"from extra_views.contrib.mixins import SearchableListMixin from rest_framework import generics from rest_framework.pagination import PageNumberPagination from\",\n \"%f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return\",\n \"if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts =\",\n \"from ..compat import reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix,\",\n \"> 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs()\",\n \"**Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\":\",\n \"likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri(\",\n \"people will use the same name to either mean a cohort or a\",\n \"[public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin,\",\n \"2. Redistributions in binary form must reproduce the above copyright # notice, this\",\n \"must retain the above copyright notice, # this list of conditions and the\",\n \"/ ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d * 100) \\\"\\\\\",\n \"result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class\",\n \"= None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart',\",\n \"of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs):\",\n \"ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF\",\n \"aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\",\",\n \"\\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\",\",\n \"a list of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if\",\n \"], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\",\",\n \"self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView):\",\n \"fitler **Tags**: survey **Examples** .. code-block:: http POST /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block::\",\n \"cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if\",\n \"matrix(self): if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self):\",\n \"\\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation\",\n \"GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\":\",\n \"questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort\",\n \"reproduce the above copyright # notice, this list of conditions and the following\",\n \"excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer =\",\n \"OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF\",\n \"responds .. code-block:: json { \\\"count\\\": 2, previous: null, next: null, results: [\",\n \"\\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\":\",\n \"\\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, {\",\n \"serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**:\",\n \"'editable_filter' def get_queryset(self): return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a\",\n \"..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers\",\n \"\\\"count\\\": 2, previous: null, next: null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\",\",\n \"\\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs):\",\n \"code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\",\",\n \"= 'path' question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if\",\n \"self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter =\",\n \"look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric\",\n \"the above copyright notice, # this list of conditions and the following disclaimer.\",\n \"both meaning. This is an attempt at magic. \\\"\\\"\\\" likely_metric = None look\",\n \"return super(EditableFilterDetailAPIView, self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes\",\n \"with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS\",\n \"= generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\"\",\n \"/api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\":\",\n \"assert 'metric' in metric.tags, \\\\ \\\"filter '%s' is not tagged as a metric\\\"\",\n \"and binary forms, with or without # modification, are permitted provided that the\",\n \"if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts =\",\n \"Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for cohorts aganist a\",\n \"#pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL to a ``Matrix``\",\n \"\\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView):\",\n \"\\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\"\",\n \"\\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path'\",\n \"cohort or a metric and expect the system will magically switch between both\",\n \"#pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores = {} if metric:\",\n \"DAMAGE. import logging, re from collections import OrderedDict from django.db.models import F from\",\n \"return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView):\",\n \"cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update(\",\n \"nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers *\",\n \"EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re\",\n \"\\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer def get_queryset(self): return Matrix.objects.all() class\",\n \"= get_account_serializer() # Implementation Note: switch cohorts from an queryset # of `EditableFilter`\",\n \"'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a\",\n \"{ \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None\",\n \"[{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\":\",\n \"/api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\"\",\n \"[{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class =\",\n \"EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**:\",\n \"`cohorts` argument # will be a list of single account objects. qs_accounts =\",\n \"responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [\",\n \"OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\",\n \"following disclaimer in the # documentation and/or other materials provided with the distribution.\",\n \"If `matrix.cohorts is None`, the `cohorts` argument # will be a list of\",\n \"**kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix: metric = self.matrix.metric else: parts =\",\n \"related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] }\",\n \"\\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None # override in\",\n \"from rest_framework.pagination import PageNumberPagination from rest_framework import response as http from ..compat import\",\n \"/api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def\",\n \"# this list of conditions and the following disclaimer. # 2. Redistributions in\",\n \"\\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None # override\",\n \"**Examples**: .. code-block:: http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts\",\n \"http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\":\",\n \".. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS\",\n \"ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE\",\n \"} \\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs):\",\n \"}] } Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all\",\n \"AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response:\",\n \"reverse from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils\",\n \"\\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\":\",\n \"\\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All\",\n \"a ``Matrix`` derived from *cohort*. Many times people will use the same name\",\n \"\\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class = MatrixSerializer def\",\n \"**kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/\",\n \"fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json\",\n \"super(EditableFilterDetailAPIView, self).delete( request, *args, **kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter\",\n \"IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from\",\n \"\\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\":\",\n \"FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\",\n \"['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a fitler\",\n \"delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples** .. code-block::\",\n \"EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list\",\n \"IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY\",\n \"LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\",\n \"\\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: {\",\n \"have a connection # and could have the same name. for cohort in\",\n \"magic. \\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric\",\n \"materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE\",\n \"\\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered\",\n \"return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**:\",\n \"system will magically switch between both meaning. This is an attempt at magic.\",\n \"201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": {\",\n \"question_model = get_question_serializer().Meta.model def aggregate_scores(self, metric, cohorts, cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is\",\n \"AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE\",\n \"= matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't have any\",\n \"<reponame>djaodjin/djaodjin-survey # Copyright (c) 2020, DjaoDjin inc. # All rights reserved. # #\",\n \"of conditions and the following disclaimer in the # documentation and/or other materials\",\n \"slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns\",\n \"self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples**\",\n \"\\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\":\",\n \"not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return\",\n \"EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix\",\n \"\\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\",\",\n \"self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())})\",\n \"= get_account_model().objects.all() scores = {} if metric: assert 'metric' in metric.tags, \\\\ \\\"filter\",\n \"cohort have a connection # and could have the same name. for cohort\",\n \"\\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return\",\n \"isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If\",\n \"'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some\",\n \".serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of\",\n \"self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use return get_account_model().objects.all() def get_likely_metric(self, cohort_slug): \\\"\\\"\\\" Returns a URL\",\n \"\\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\"\",\n \"metric\\\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions =\",\n \"if not cohorts: # We don't have any cohorts, let's show individual accounts\",\n \"\\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1\",\n \"None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=(\",\n \"**includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument # will be\",\n \"\\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset():\",\n \"\\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView,\",\n \"matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer cohorts =\",\n \".. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination\",\n \"in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def\",\n \"the same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric']\",\n \"serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block::\",\n \"paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view)\",\n \"100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s' = (%d * 100)\",\n \"('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects\",\n \"metric and cohort have a connection # and could have the same name.\",\n \"} ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request, *args, **kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView):\",\n \"qs_accounts = accounts.filter( **includes).exclude(**excludes) else: # If `matrix.cohorts is None`, the `cohorts` argument\",\n \"ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\",\n \"between both meaning. This is an attempt at magic. \\\"\\\"\\\" likely_metric = None\",\n \"cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() #\",\n \"the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\",\n \"self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return\",\n \"EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts:\",\n \"json { \\\"count\\\": 2, previous: null, next: null, results: [ { \\\"slug\\\": \\\"all\\\",\",\n \"matrix.cut if not cohorts: # We don't have any cohorts, let's show individual\",\n \"that the following conditions are met: # # 1. Redistributions of source code\",\n \"subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self,\",\n \"\\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class = get_account_serializer()\",\n \"objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers =\",\n \"a metric and cohort have a connection # and could have the same\",\n \"table of scores for cohorts aganist a metric. **Examples**: .. code-block:: http GET\",\n \"same name. for cohort in val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] =\",\n \"instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts\",\n \"CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY,\",\n \"disclaimer. # 2. Redistributions in binary form must reproduce the above copyright #\",\n \"null, next: null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\":\",\n \"from collections import OrderedDict from django.db.models import F from django.http import Http404 from\",\n \"A table of scores for cohorts aganist a metric. **Examples**: .. code-block:: http\",\n \"same name to either mean a cohort or a metric and expect the\",\n \"questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field\",\n \"objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block::\",\n \"code must retain the above copyright notice, # this list of conditions and\",\n \"``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All\",\n \"CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\",\n \"BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN\",\n \"GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\":\",\n \"str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\":\",\n \"cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: #\",\n \"the following conditions are met: # # 1. Redistributions of source code must\",\n \"/api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\":\",\n \"IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\",\n \"scores = {} if metric: assert 'metric' in metric.tags, \\\\ \\\"filter '%s' is\",\n \"else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not\",\n \"next: null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [\",\n \"request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey **Examples** .. code-block:: http\",\n \"*args, **kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler **Tags**: survey\",\n \"THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE\",\n \"fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block::\",\n \"\\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" search_fields = ['tags'] serializer_class = EditableFilterSerializer def\",\n \"be a list of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts)\",\n \"def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous',\",\n \"{ \\\"count\\\": 2, previous: null, next: null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"INCLUDING, BUT NOT LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\",\n \"[ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\":\",\n \"[ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\":\",\n \"return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for cohorts aganist\",\n \"EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/\",\n \"EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohorts)} # In some case, a metric and cohort have a\",\n \"AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL\",\n \"STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY\",\n \"IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF #\",\n \"[] }] } Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against\",\n \"if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return\",\n \"ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\",\n \"}] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model =\",\n \"null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\":\",\n \"} responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\":\",\n \"\\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ]\",\n \"self).put( request, *args, **kwargs) def delete(self, request, *args, **kwargs): \\\"\\\"\\\" Deletes a fitler\",\n \"\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED #\",\n \"metric: assert 'metric' in metric.tags, \\\\ \\\"filter '%s' is not tagged as a\",\n \"\\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\" serializer_class =\",\n \"django.db.models import F from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins\",\n \"self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter\",\n \"list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\",\",\n \"the following disclaimer in the # documentation and/or other materials provided with the\",\n \"return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation(\",\n \"must reproduce the above copyright # notice, this list of conditions and the\",\n \"import logging, re from collections import OrderedDict from django.db.models import F from django.http\",\n \"serializer_class = EditableFilterSerializer lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return EditableFilter.objects.all()\",\n \"We don't have any cohorts, let's show individual accounts instead. if cut: includes,\",\n \"SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\",\n \"to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\": \\\"text\\\", \\\"selector\\\":\\\"keepmatching\\\" }] } \\\"\\\"\\\"\",\n \"2, previous: null, next: null, results: [ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\":\",\n \"\\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\":\",\n \"GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all questions\\\" \\\"scores\\\":{\",\n \"\\\"/ (%d * %d) = %f\\\", str(cohort), nb_correct_answers, nb_questions, nb_accounts, score) assert score\",\n \"OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF\",\n \"cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else:\",\n \"if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts = accounts.filter( **includes).exclude(**excludes) else: #\",\n \"HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [\",\n \"code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\":\",\n \"0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes, excludes = cohort.as_kwargs() qs_accounts\",\n \"**kwargs) class EditableFilterPagination(PageNumberPagination): def paginate_queryset(self, queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination,\",\n \"an attempt at magic. \\\"\\\"\\\" likely_metric = None look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if\",\n \"code-block:: json { \\\"count\\\": 2, previous: null, next: null, results: [ { \\\"slug\\\":\",\n \"list of single account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts\",\n \"OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\",\n \"**kwargs) class EditableFilterDetailAPIView(generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http\",\n \"{} val = { 'slug': metric.slug, 'title': metric.title, 'metric': EditableFilterSerializer().to_representation(metric), 'cut': EditableFilterSerializer().to_representation(cut), 'cohorts':\",\n \"TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\",\n \"logging, re from collections import OrderedDict from django.db.models import F from django.http import\",\n \"val['cohorts']: likely_metric = self.get_likely_metric(cohort['slug']) if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric,\",\n \"[] }] } .. code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\",\n \"of `Account` ... cohorts = accounts result = [] scores = {} val\",\n \"get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET\",\n \"**Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions\",\n \"1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }\",\n \"`EditableFilter` to a queryset of `Account` ... cohorts = accounts result = []\",\n \"IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED # TO,\",\n \"Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\":\",\n \"the # documentation and/or other materials provided with the distribution. # # THIS\",\n \"class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List\",\n \"survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json {\",\n \"\\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET /api/matrix/ Response: {\",\n \"EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey **Examples**\",\n \"len(questions) if nb_questions > 0: for cohort in cohorts: if isinstance(cohort, EditableFilter): includes,\",\n \"nb_questions, nb_accounts, score) assert score <= 100 scores.update({str(cohort): score}) return {\\\"scores\\\": scores} @property\",\n \"class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey **Examples** .. code-block:: http GET\",\n \"raise Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut =\",\n \"result += [scores] if public_cohorts: public_scores = {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts,\",\n \"@staticmethod def get_queryset(): return EditableFilter.objects.all() class EditableFilterListAPIView(SearchableListMixin, EditableFilterQuerysetMixin, generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**:\",\n \"other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY\",\n \"LIMITED # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\",\n \"\\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } .. code-block:: http POST\",\n \"list of conditions and the following disclaimer in the # documentation and/or other\",\n \"in metric.tags, \\\\ \\\"filter '%s' is not tagged as a metric\\\" % str(metric)\",\n \"= {} public_scores.update(val) public_scores.update( {\\\"cohorts\\\": EditableFilterSerializer( public_cohorts, many=True).data, \\\"values\\\": self.aggregate_scores(metric, public_cohorts)}) result +=\",\n \"} .. code-block:: http POST /api/matrix/ { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against\",\n \"\\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post( request,\",\n \"**Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json\",\n \"GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 }\",\n \"accounts\\\", \\\"predicates\\\": [] }] } Response: 201 CREATED { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\",\n \"code-block:: http GET /api/matrix/languages Response: [{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All cohorts for all\",\n \"serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg = 'path' question_model = get_question_serializer().Meta.model def\",\n \"if not hasattr(self, '_matrix'): self._matrix = Matrix.objects.filter( slug=self.kwargs.get(self.matrix_url_kwarg)).first() return self._matrix def get_accounts(self): #pylint:disable=unused-argument,no-self-use\",\n \"get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix: raise Http404() cohort_serializer = EditableFilterSerializer\",\n \"= 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args,\",\n \"# Copyright (c) 2020, DjaoDjin inc. # All rights reserved. # # Redistribution\",\n \"\\\"All\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\",\",\n \"LOGGER = logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block::\",\n \".. code-block:: http GET /api/matrix/ Response: { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All accounts against\",\n \"``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All\",\n \"SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION) HOWEVER CAUSED\",\n \"from ..mixins import MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import\",\n \"cohorts from an queryset # of `EditableFilter` to a queryset of `Account` ...\",\n \"[] }, \\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] }\",\n \"get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView,\",\n \"if metric: assert 'metric' in metric.tags, \\\\ \\\"filter '%s' is not tagged as\",\n \"\\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } Response: 201 CREATED {\",\n \"super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)),\",\n \"= metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0:\",\n \"a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation\",\n \"\\\"\\\"\\\" Returns a URL to a ``Matrix`` derived from *cohort*. Many times people\",\n \"the same name to either mean a cohort or a metric and expect\",\n \"re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist:\",\n \"as a metric\\\" % str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes)\",\n \"logging.getLogger(__name__) class MatrixCreateAPIView(generics.ListCreateAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: .. code-block:: http GET\",\n \"not tagged as a metric\\\" % str(metric) includes, excludes = metric.as_kwargs() questions =\",\n \"reserved. # # Redistribution and use in source and binary forms, with or\",\n \"return likely_metric def get(self, request, *args, **kwargs): #pylint:disable=unused-argument,too-many-locals matrix = self.matrix if matrix:\",\n \"\\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json\",\n \"# Redistribution and use in source and binary forms, with or without #\",\n \"\\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg =\",\n \"\\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView, self).post(\",\n \"Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\"\",\n \"get_queryset(self): return Matrix.objects.all() class MatrixDetailAPIView(MatrixMixin, generics.RetrieveUpdateDestroyAPIView): \\\"\\\"\\\" A table of scores for cohorts\",\n \"return EditableFilter.objects.all() def put(self, request, *args, **kwargs): \\\"\\\"\\\" Updates a fitler **Tags**: survey\",\n \"http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\":\",\n \"metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores = {} public_scores.update(val)\",\n \"against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All questions\\\", \\\"predicates\\\": [] },\",\n \"cut=None, accounts=None): #pylint:disable=unused-argument,too-many-locals if accounts is None: accounts = get_account_model().objects.all() scores = {}\",\n \"view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()),\",\n \"Returns a URL to a ``Matrix`` derived from *cohort*. Many times people will\",\n \"code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"count\\\": 2, previous:\",\n \"EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER\",\n \"{ \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\",\",\n \"lookup_url_kwarg = 'editable_filter' def get_queryset(self): return self.get_serializer_class().Meta.model.objects.all() def get(self, request, *args, **kwargs): #pylint:\",\n \"public_cohorts)}) result += [public_scores] return http.Response(result) class EditableFilterQuerysetMixin(object): @staticmethod def get_queryset(): return EditableFilter.objects.all()\",\n \"# We don't have any cohorts, let's show individual accounts instead. if cut:\",\n \"\\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\",\",\n \"= ['tags'] serializer_class = EditableFilterSerializer def post(self, request, *args, **kwargs): \\\"\\\"\\\" Create a\",\n \"\\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class = EditableFilterPagination serializer_class = None #\",\n \"self.matrix.metric else: parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if\",\n \"look = re.match(r\\\"(\\\\S+)(-\\\\d+)\\\", cohort_slug) if look: try: likely_metric = self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,)))\",\n \"are permitted provided that the following conditions are met: # # 1. Redistributions\",\n \"generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return super(EditableFilterObjectsAPIView, self).get( request, *args, **kwargs) class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered\",\n \"\\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``. **Examples**: ..\",\n \"generics.ListCreateAPIView): \\\"\\\"\\\" List fitlers **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1\",\n \"will magically switch between both meaning. This is an attempt at magic. \\\"\\\"\\\"\",\n \"a fitler **Tags**: survey **Examples** .. code-block:: http PUT /api/xia/matrix/filters/all/ HTTP/1.1 .. code-block::\",\n \"survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1 \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterDetailAPIView, self).delete(\",\n \"self.request.build_absolute_uri( reverse('matrix_chart', args=( EditableFilter.objects.get(slug=look.group(1)).slug,))) except EditableFilter.DoesNotExist: pass return likely_metric def get(self, request, *args,\",\n \"ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\",\n \"NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\",\n \"derived from *cohort*. Many times people will use the same name to either\",\n \"cohorts = accounts result = [] scores = {} val = { 'slug':\",\n \"> 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score = nb_correct_answers * 100\",\n \"GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; # OR BUSINESS INTERRUPTION)\",\n \".. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\",\",\n \"Http404() cohort_serializer = EditableFilterSerializer cohorts = matrix.cohorts.exclude(tags__contains='aggregate') public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut\",\n \"scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result += [scores] if public_cohorts: public_scores\",\n \"\\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds .. code-block::\",\n \"list of ``Question``. **Examples**: .. code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\",\",\n \"ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import logging, re from collections import\",\n \"from rest_framework import response as http from ..compat import reverse from ..mixins import\",\n \"**Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds .. code-block:: json { \\\"slug\\\":\",\n \"account objects. qs_accounts = [cohort] nb_accounts = len(qs_accounts) if nb_accounts > 0: nb_correct_answers\",\n \"binary forms, with or without # modification, are permitted provided that the following\",\n \"\\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1,\",\n \"% str(metric) includes, excludes = metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions)\",\n \"times people will use the same name to either mean a cohort or\",\n \"..utils import (get_account_model, get_account_serializer, get_question_serializer) from .serializers import EditableFilterSerializer, MatrixSerializer LOGGER = logging.getLogger(__name__)\",\n \"OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY,\",\n \"\\\"\\\"\\\" Deletes a fitler **Tags**: survey **Examples** .. code-block:: http DELETE /api/xia/matrix/filters/all/ HTTP/1.1\",\n \"self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**:\",\n \"# 2. Redistributions in binary form must reproduce the above copyright # notice,\",\n \"('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List\",\n \"None # override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def get_queryset(self):\",\n \"\\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\": 1, \\\"operator\\\": \\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\",\",\n \"distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\",\n \"**includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for cohort in cohorts: if\",\n \"import F from django.http import Http404 from django.shortcuts import get_object_or_404 from extra_views.contrib.mixins import\",\n \"\\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } \\\"\\\"\\\" serializer_class\",\n \"Retrieve a fitler **Tags**: survey **Examples** .. code-block:: http GET /api/xia/matrix/filters/all/ HTTP/1.1 responds\",\n \"\\\"\\\", \\\"operand\\\": \\\"\\\", \\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } responds ..\",\n \"WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING\",\n \"*args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey **Examples** .. code-block:: http POST\",\n \"# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF\",\n \"\\\"all\\\", \\\"title\\\": \\\"All accounts against all questions\\\", \\\"metric\\\": { \\\"slug\\\": \\\"all-questions\\\", \\\"title\\\": \\\"All\",\n \"self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch\",\n \"\\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\": \\\"language\\\", \\\"field\\\":\",\n \"LOGGER.debug(\\\"score for '%s' = (%d * 100) \\\"\\\\ \\\"/ (%d * %d) =\",\n \"# # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS #\",\n \"}] } \\\"\\\"\\\" serializer_class = get_account_serializer() class QuestionListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``Question``.\",\n \"metric and expect the system will magically switch between both meaning. This is\",\n \"# In some case, a metric and cohort have a connection # and\",\n \"MatrixMixin from ..models import Answer, Matrix, EditableFilter from ..utils import (get_account_model, get_account_serializer, get_question_serializer)\",\n \"metric.as_kwargs() questions = self.question_model.objects.filter( **includes).exclude(**excludes) nb_questions = len(questions) if nb_questions > 0: for\",\n \"\\\"likely_metric\\\": \\\"\\\" } responds .. code-block:: json { \\\"slug\\\": \\\"all\\\", \\\"title\\\": \\\"All\\\", \\\"tags\\\":\",\n \"of scores for cohorts aganist a metric. **Examples**: .. code-block:: http GET /api/matrix/languages\",\n \"('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('results', data) ])) class\",\n \"**Examples** .. code-block:: http GET /api/xia/matrix/filters/ HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\":\",\n \"and expect the system will magically switch between both meaning. This is an\",\n \"code-block:: http GET /api/questions/languages Response: { \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to\",\n \"OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR # PURPOSE ARE DISCLAIMED. IN NO\",\n \"to either mean a cohort or a metric and expect the system will\",\n \"\\\"likely_metric\\\": \\\"\\\" }, { \\\"slug\\\": \\\"none\\\", \\\"title\\\": \\\"None\\\", \\\"tags\\\": \\\"\\\", \\\"predicates\\\": [ \\\"rank\\\":\",\n \"if likely_metric: cohort['likely_metric'] = likely_metric scores.update(val) scores.update({\\\"values\\\": self.aggregate_scores( metric, cohorts, cut, accounts=self.get_accounts())}) result\",\n \"cohorts for all questions\\\" \\\"scores\\\":{ \\\"portfolio-a\\\": \\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class\",\n \"parts = self.kwargs.get(self.matrix_url_kwarg).split('/') metric = get_object_or_404(EditableFilter, slug=parts[-1]) matrix = Matrix.objects.filter(slug=parts[0]).first() if not matrix:\",\n \"HTTP/1.1 responds .. code-block:: json { \\\"created_at\\\": \\\"2020-01-01T00:00:00Z\\\", \\\"measured\\\": 12 } \\\"\\\"\\\" pagination_class\",\n \"includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes) else: accounts = self.get_accounts() cohort_serializer\",\n \"(c) 2020, DjaoDjin inc. # All rights reserved. # # Redistribution and use\",\n \"queryset, request, view=None): self.editable_filter = view.editable_filter return super(EditableFilterPagination, self).paginate_queryset( queryset, request, view=view) def\",\n \"def get(self, request, *args, **kwargs): #pylint: disable=unused-argument self.editable_filter = generics.get_object_or_404( EditableFilter.objects.all(), slug=self.kwargs[self.lookup_url_kwarg]) return\",\n \"individual accounts instead. if cut: includes, excludes = cut.as_kwargs() accounts = self.get_accounts().filter( **includes).exclude(**excludes)\",\n \"request, *args, **kwargs): \\\"\\\"\\\" Create a fitler **Tags**: survey **Examples** .. code-block:: http\",\n \"public_cohorts = matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't have\",\n \"else: accounts = self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from\",\n \"OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, # PROCUREMENT OF SUBSTITUTE GOODS\",\n \"\\\"0.1\\\", \\\"portfolio-b\\\": \\\"0.5\\\", } }] \\\"\\\"\\\" serializer_class = MatrixSerializer lookup_field = 'slug' lookup_url_kwarg\",\n \"INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\",\n \"= None # override in subclasses lookup_field = 'slug' lookup_url_kwarg = 'editable_filter' def\",\n \"# modification, are permitted provided that the following conditions are met: # #\",\n \"cut = matrix.cut if not cohorts: # We don't have any cohorts, let's\",\n \"\\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return\",\n \"score = nb_correct_answers * 100 / ( nb_questions * nb_accounts) LOGGER.debug(\\\"score for '%s'\",\n \"BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, # EXEMPLARY, OR CONSEQUENTIAL DAMAGES\",\n \"\\\"field\\\": \\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } \\\"\\\"\\\" serializer_class = EditableFilterSerializer lookup_field\",\n \"{ \\\"slug\\\": \\\"languages\\\", \\\"title\\\": \\\"All questions related to languages\\\" \\\"predicates\\\":[{ \\\"operator\\\": \\\"contains\\\", \\\"operand\\\":\",\n \"\\\"\\\", \\\"selector\\\": \\\"\\\" ], \\\"likely_metric\\\": \\\"\\\" } ] } \\\"\\\"\\\" #pylint:disable=useless-super-delegation return super(EditableFilterListAPIView,\",\n \"source code must retain the above copyright notice, # this list of conditions\",\n \"('results', data) ])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey **Examples** ..\",\n \"class AccountListAPIView(EditableFilterObjectsAPIView): \\\"\\\"\\\" Filtered list of ``EditableFilter``. **Examples**: .. code-block:: http GET /api/questions/languages\",\n \"copyright # notice, this list of conditions and the following disclaimer in the\",\n \"self.get_accounts() cohort_serializer = get_account_serializer() # Implementation Note: switch cohorts from an queryset #\",\n \"matrix.cohorts.filter(tags__contains='aggregate') cut = matrix.cut if not cohorts: # We don't have any cohorts,\",\n \"above copyright notice, # this list of conditions and the following disclaimer. #\",\n \"len(qs_accounts) if nb_accounts > 0: nb_correct_answers = Answer.objects.filter( question__in=questions, sample__account__in=qs_accounts).filter( measured=F('question__correct_answer')).count() score =\",\n \"\\\"cohorts\\\": [{ \\\"slug\\\": \\\"all-accounts\\\", \\\"title\\\": \\\"All accounts\\\", \\\"predicates\\\": [] }] } .. code-block::\",\n \"])) class EditableFilterObjectsAPIView(generics.ListAPIView): \\\"\\\"\\\" List filter objects **Tags**: survey **Examples** .. code-block:: http\",\n \"self).paginate_queryset( queryset, request, view=view) def get_paginated_response(self, data): return http.Response(OrderedDict([ ('editable_filter', EditableFilterSerializer().to_representation( self.editable_filter)), ('count',\"\n]","isConversational":false}}},{"rowIdx":283,"cells":{"ngram":{"kind":"list like","value":["or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials =","'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials from storage.","with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path)","flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only for compatibility with","print_function import httplib2 import os import sys import pickle from apiclient import discovery","os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if","If modifying these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES","('Label id: %s - Label name: %s' % (label['id'], label['name'])) \"\"\" return labels","credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId =","GetLabels(service, userId) for label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name'])","errors.HttpError as error: print ('An error occurred: %s' % error) def main(): credentials","obtain the new credentials. Returns: Credentials, the obtained credential. \"\"\" home_dir = os.path.expanduser('~')","Returns: Credentials, the obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials')","occurred: %s' % error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service","import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying","from apiclient import errors from oauth2client import client from oauth2client import tools from","the obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not","= credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service,","oauth2client import tools from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args()","(label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__ == '__main__':","store) print('Storing credentials to ' + credential_path) return credentials def GetLabels(service, user_id): try:","labels = GetLabels(service, userId) for label in labels: if (label['type'] == 'user'): print('Deleting","import client from oauth2client import tools from oauth2client.file import Storage try: import argparse","httplib2 import os import sys import pickle from apiclient import discovery from apiclient","error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print","error: print ('An error occurred: %s' % error) def main(): credentials = get_credentials()","the stored credentials are invalid, the OAuth2 flow is completed to obtain the","import httplib2 import os import sys import pickle from apiclient import discovery from","def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label","% label_id) except errors.HttpError as error: print ('An error occurred: %s' % error)","argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these scopes, delete your","for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to '","to ' + credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute()","credentials to ' + credential_path) return credentials def GetLabels(service, user_id): try: response =","from apiclient import discovery from apiclient import errors from oauth2client import client from","occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label","%s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with","as error: print ('An error occurred: %s' % error) def main(): credentials =","flags = None # If modifying these scopes, delete your previously saved credentials","'me' labels = GetLabels(service, userId) for label in labels: if (label['type'] == 'user'):","= 'me' labels = GetLabels(service, userId) for label in labels: if (label['type'] ==","Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None #","store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME","new credentials. Returns: Credentials, the obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir =","else: # Needed only for compatibility with Python 2.6 credentials = tools.run(flow, store)","nothing has been stored, or if the stored credentials are invalid, the OAuth2","% error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail',","credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials def","discovery from apiclient import errors from oauth2client import client from oauth2client import tools","= argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these scopes, delete","scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE","credentials = store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent","= Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE,","with id: %s deleted successfully.' % label_id) except errors.HttpError as error: print ('An","= os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir,","= get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me'","= tools.run_flow(flow, store, flags) else: # Needed only for compatibility with Python 2.6","for label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId,","import print_function import httplib2 import os import sys import pickle from apiclient import","successfully.' % label_id) except errors.HttpError as error: print ('An error occurred: %s' %","def get_credentials(): \"\"\"Gets valid user credentials from storage. If nothing has been stored,","= os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store =","# at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize'","Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES)","try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label in labels: print","client from oauth2client import tools from oauth2client.file import Storage try: import argparse flags","if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only for compatibility","= None # If modifying these scopes, delete your previously saved credentials #","def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http)","name: %s' % (label['id'], label['name'])) \"\"\" return labels except errors.HttpError as error: print","tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials def GetLabels(service, user_id):","main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId","labels except errors.HttpError as error: print ('An error occurred: %s' % error) def","modifying these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES =","APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only for","error: print ('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try:","user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label in labels:","os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not","client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else:","from __future__ import print_function import httplib2 import os import sys import pickle from","%s deleted successfully.' % label_id) except errors.HttpError as error: print ('An error occurred:","userId = 'me' labels = GetLabels(service, userId) for label in labels: if (label['type']","= os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials or","are invalid, the OAuth2 flow is completed to obtain the new credentials. Returns:","2.6 credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials","sys import pickle from apiclient import discovery from apiclient import errors from oauth2client","print('Storing credentials to ' + credential_path) return credentials def GetLabels(service, user_id): try: response","errors.HttpError as error: print ('An error occurred: %s' % error) def DeleteLabel(service, user_id,","(label['id'], label['name'])) \"\"\" return labels except errors.HttpError as error: print ('An error occurred:","has been stored, or if the stored credentials are invalid, the OAuth2 flow","credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store","credentials = tools.run_flow(flow, store, flags) else: # Needed only for compatibility with Python","= response['labels'] \"\"\" for label in labels: print ('Label id: %s - Label","print ('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id,","label in labels: print ('Label id: %s - Label name: %s' % (label['id'],","os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json')","\"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path","GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label in","home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path =","from storage. If nothing has been stored, or if the stored credentials are","print ('Label id: %s - Label name: %s' % (label['id'], label['name'])) \"\"\" return","= 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid","oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags =","= 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials from","return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\"","CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials","credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox","http=http) userId = 'me' labels = GetLabels(service, userId) for label in labels: if","= 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials from storage. If nothing","credentials are invalid, the OAuth2 flow is completed to obtain the new credentials.","' + credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels","APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials from storage. If","tools from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError:","%s' % (label['id'], label['name'])) \"\"\" return labels except errors.HttpError as error: print ('An","get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels","if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__ ==","if the stored credentials are invalid, the OAuth2 flow is completed to obtain","None # If modifying these scopes, delete your previously saved credentials # at","'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow","these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels'","'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user","if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if","import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None","def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted","or if the stored credentials are invalid, the OAuth2 flow is completed to","tools.run_flow(flow, store, flags) else: # Needed only for compatibility with Python 2.6 credentials","for label in labels: print ('Label id: %s - Label name: %s' %","__future__ import print_function import httplib2 import os import sys import pickle from apiclient","from oauth2client import tools from oauth2client.file import Storage try: import argparse flags =","DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.'","delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE =","labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__","flow is completed to obtain the new credentials. Returns: Credentials, the obtained credential.","been stored, or if the stored credentials are invalid, the OAuth2 flow is","os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid:","Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path) return","'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for label in labels:","previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME","= store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent =","apiclient import errors from oauth2client import client from oauth2client import tools from oauth2client.file","storage. If nothing has been stored, or if the stored credentials are invalid,","OAuth2 flow is completed to obtain the new credentials. Returns: Credentials, the obtained","compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to ' +","print ('An error occurred: %s' % error) def main(): credentials = get_credentials() http","discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for label in","= APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only","label_id) except errors.HttpError as error: print ('An error occurred: %s' % error) def","only for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to","('Label with id: %s deleted successfully.' % label_id) except errors.HttpError as error: print","Organize' def get_credentials(): \"\"\"Gets valid user credentials from storage. If nothing has been","Credentials, the obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if","to obtain the new credentials. Returns: Credentials, the obtained credential. \"\"\" home_dir =","credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow,","ImportError: flags = None # If modifying these scopes, delete your previously saved","label['name'])) \"\"\" return labels except errors.HttpError as error: print ('An error occurred: %s'","response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label in labels: print ('Label","= tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials def GetLabels(service,","get_credentials(): \"\"\"Gets valid user credentials from storage. If nothing has been stored, or","Needed only for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials","is completed to obtain the new credentials. Returns: Credentials, the obtained credential. \"\"\"","response['labels'] \"\"\" for label in labels: print ('Label id: %s - Label name:","flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these scopes,","labels = response['labels'] \"\"\" for label in labels: print ('Label id: %s -","except errors.HttpError as error: print ('An error occurred: %s' % error) def DeleteLabel(service,","If nothing has been stored, or if the stored credentials are invalid, the","~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials():","labels: print ('Label id: %s - Label name: %s' % (label['id'], label['name'])) \"\"\"","'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials from storage. If nothing has","%s - Label name: %s' % (label['id'], label['name'])) \"\"\" return labels except errors.HttpError","= service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label in labels: print ('Label id:","your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json'","('An error occurred: %s' % error) def main(): credentials = get_credentials() http =","valid user credentials from storage. If nothing has been stored, or if the","% (label['id'], label['name'])) \"\"\" return labels except errors.HttpError as error: print ('An error","flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed","+ credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels =","service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for","saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME =","# Needed only for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing","at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def","credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for","# If modifying these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json","in labels: print ('Label id: %s - Label name: %s' % (label['id'], label['name']))","invalid, the OAuth2 flow is completed to obtain the new credentials. Returns: Credentials,","the OAuth2 flow is completed to obtain the new credentials. Returns: Credentials, the","('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute()","os import sys import pickle from apiclient import discovery from apiclient import errors","service.users().labels().list(userId=user_id).execute() labels = response['labels'] \"\"\" for label in labels: print ('Label id: %s","import os import sys import pickle from apiclient import discovery from apiclient import","except errors.HttpError as error: print ('An error occurred: %s' % error) def main():","return labels except errors.HttpError as error: print ('An error occurred: %s' % error)","errors from oauth2client import client from oauth2client import tools from oauth2client.file import Storage","% error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id:","error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1',","credentials. Returns: Credentials, the obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir,","in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if","stored credentials are invalid, the OAuth2 flow is completed to obtain the new","credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir)","os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path)","\"\"\" for label in labels: print ('Label id: %s - Label name: %s'","store = Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow =","error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s","\"\"\" return labels except errors.HttpError as error: print ('An error occurred: %s' %","if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials =","obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir):","= client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags)","SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: #","- Label name: %s' % (label['id'], label['name'])) \"\"\" return labels except errors.HttpError as","user credentials from storage. If nothing has been stored, or if the stored","try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If","userId) for label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service,","id: %s deleted successfully.' % label_id) except errors.HttpError as error: print ('An error","import pickle from apiclient import discovery from apiclient import errors from oauth2client import","\"\"\"Gets valid user credentials from storage. If nothing has been stored, or if","'.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials","user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' %","apiclient import discovery from apiclient import errors from oauth2client import client from oauth2client","= discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for label","store, flags) else: # Needed only for compatibility with Python 2.6 credentials =","except ImportError: flags = None # If modifying these scopes, delete your previously","id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id) except errors.HttpError as","label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id)","id: %s - Label name: %s' % (label['id'], label['name'])) \"\"\" return labels except","oauth2client import client from oauth2client import tools from oauth2client.file import Storage try: import","not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get()","stored, or if the stored credentials are invalid, the OAuth2 flow is completed","service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id) except errors.HttpError","deleted successfully.' % label_id) except errors.HttpError as error: print ('An error occurred: %s'","credentials from storage. If nothing has been stored, or if the stored credentials","credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials","import errors from oauth2client import client from oauth2client import tools from oauth2client.file import","error occurred: %s' % error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http())","= GetLabels(service, userId) for label in labels: if (label['type'] == 'user'): print('Deleting label:',","the new credentials. Returns: Credentials, the obtained credential. \"\"\" home_dir = os.path.expanduser('~') credential_dir","http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels =","pickle from apiclient import discovery from apiclient import errors from oauth2client import client","as error: print ('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id):","credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId)","completed to obtain the new credentials. Returns: Credentials, the obtained credential. \"\"\" home_dir","import sys import pickle from apiclient import discovery from apiclient import errors from","import discovery from apiclient import errors from oauth2client import client from oauth2client import","not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags:","from oauth2client import client from oauth2client import tools from oauth2client.file import Storage try:","try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id) except","Label name: %s' % (label['id'], label['name'])) \"\"\" return labels except errors.HttpError as error:","flags) else: # Needed only for compatibility with Python 2.6 credentials = tools.run(flow,","== 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__ == '__main__': main()","from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags","argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these","print ('Label with id: %s deleted successfully.' % label_id) except errors.HttpError as error:","label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id'])","credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels']","SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets","%s' % error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service =","credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials","import tools from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except","flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store,"],"string":"[\n \"or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials =\",\n \"'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage.\",\n \"with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path)\",\n \"flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only for compatibility with\",\n \"print_function import httplib2 import os import sys import pickle from apiclient import discovery\",\n \"os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if\",\n \"If modifying these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES\",\n \"('Label id: %s - Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels\",\n \"credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId =\",\n \"GetLabels(service, userId) for label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name'])\",\n \"errors.HttpError as error: print ('An error occurred: %s' % error) def main(): credentials\",\n \"obtain the new credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~')\",\n \"Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials')\",\n \"occurred: %s' % error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service\",\n \"import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying\",\n \"from apiclient import errors from oauth2client import client from oauth2client import tools from\",\n \"the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not\",\n \"= credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service,\",\n \"oauth2client import tools from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args()\",\n \"(label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__ == '__main__':\",\n \"store) print('Storing credentials to ' + credential_path) return credentials def GetLabels(service, user_id): try:\",\n \"labels = GetLabels(service, userId) for label in labels: if (label['type'] == 'user'): print('Deleting\",\n \"import client from oauth2client import tools from oauth2client.file import Storage try: import argparse\",\n \"httplib2 import os import sys import pickle from apiclient import discovery from apiclient\",\n \"error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print\",\n \"error: print ('An error occurred: %s' % error) def main(): credentials = get_credentials()\",\n \"the stored credentials are invalid, the OAuth2 flow is completed to obtain the\",\n \"import httplib2 import os import sys import pickle from apiclient import discovery from\",\n \"def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label\",\n \"% label_id) except errors.HttpError as error: print ('An error occurred: %s' % error)\",\n \"argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these scopes, delete your\",\n \"for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to '\",\n \"to ' + credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute()\",\n \"credentials to ' + credential_path) return credentials def GetLabels(service, user_id): try: response =\",\n \"from apiclient import discovery from apiclient import errors from oauth2client import client from\",\n \"occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label\",\n \"%s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with\",\n \"as error: print ('An error occurred: %s' % error) def main(): credentials =\",\n \"flags = None # If modifying these scopes, delete your previously saved credentials\",\n \"'me' labels = GetLabels(service, userId) for label in labels: if (label['type'] == 'user'):\",\n \"= 'me' labels = GetLabels(service, userId) for label in labels: if (label['type'] ==\",\n \"Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None #\",\n \"store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME\",\n \"new credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir =\",\n \"else: # Needed only for compatibility with Python 2.6 credentials = tools.run(flow, store)\",\n \"nothing has been stored, or if the stored credentials are invalid, the OAuth2\",\n \"% error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail',\",\n \"credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials def\",\n \"discovery from apiclient import errors from oauth2client import client from oauth2client import tools\",\n \"= argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these scopes, delete\",\n \"scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE\",\n \"credentials = store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent\",\n \"= Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE,\",\n \"with id: %s deleted successfully.' % label_id) except errors.HttpError as error: print ('An\",\n \"= os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir,\",\n \"= get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me'\",\n \"= tools.run_flow(flow, store, flags) else: # Needed only for compatibility with Python 2.6\",\n \"for label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId,\",\n \"import print_function import httplib2 import os import sys import pickle from apiclient import\",\n \"successfully.' % label_id) except errors.HttpError as error: print ('An error occurred: %s' %\",\n \"def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage. If nothing has been stored,\",\n \"= os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store =\",\n \"# at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize'\",\n \"Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES)\",\n \"try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label in labels: print\",\n \"client from oauth2client import tools from oauth2client.file import Storage try: import argparse flags\",\n \"if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only for compatibility\",\n \"= None # If modifying these scopes, delete your previously saved credentials #\",\n \"def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http)\",\n \"name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as error: print\",\n \"tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials def GetLabels(service, user_id):\",\n \"main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId\",\n \"labels except errors.HttpError as error: print ('An error occurred: %s' % error) def\",\n \"modifying these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES =\",\n \"APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only for\",\n \"error: print ('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try:\",\n \"user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label in labels:\",\n \"os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not\",\n \"client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else:\",\n \"from __future__ import print_function import httplib2 import os import sys import pickle from\",\n \"%s deleted successfully.' % label_id) except errors.HttpError as error: print ('An error occurred:\",\n \"userId = 'me' labels = GetLabels(service, userId) for label in labels: if (label['type']\",\n \"= os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials or\",\n \"are invalid, the OAuth2 flow is completed to obtain the new credentials. Returns:\",\n \"2.6 credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials\",\n \"sys import pickle from apiclient import discovery from apiclient import errors from oauth2client\",\n \"print('Storing credentials to ' + credential_path) return credentials def GetLabels(service, user_id): try: response\",\n \"errors.HttpError as error: print ('An error occurred: %s' % error) def DeleteLabel(service, user_id,\",\n \"(label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as error: print ('An error occurred:\",\n \"has been stored, or if the stored credentials are invalid, the OAuth2 flow\",\n \"credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store\",\n \"credentials = tools.run_flow(flow, store, flags) else: # Needed only for compatibility with Python\",\n \"= response['labels'] \\\"\\\"\\\" for label in labels: print ('Label id: %s - Label\",\n \"print ('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id,\",\n \"label in labels: print ('Label id: %s - Label name: %s' % (label['id'],\",\n \"os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json')\",\n \"\\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path\",\n \"GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label in\",\n \"home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path =\",\n \"from storage. If nothing has been stored, or if the stored credentials are\",\n \"print ('Label id: %s - Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return\",\n \"= 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid\",\n \"oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags =\",\n \"= 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from\",\n \"return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\"\",\n \"CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials\",\n \"credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox\",\n \"http=http) userId = 'me' labels = GetLabels(service, userId) for label in labels: if\",\n \"= 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage. If nothing\",\n \"credentials are invalid, the OAuth2 flow is completed to obtain the new credentials.\",\n \"' + credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels\",\n \"APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage. If\",\n \"tools from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError:\",\n \"%s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as error: print ('An\",\n \"get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels\",\n \"if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__ ==\",\n \"if the stored credentials are invalid, the OAuth2 flow is completed to obtain\",\n \"None # If modifying these scopes, delete your previously saved credentials # at\",\n \"'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow\",\n \"these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels'\",\n \"'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user\",\n \"if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if\",\n \"import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None\",\n \"def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted\",\n \"or if the stored credentials are invalid, the OAuth2 flow is completed to\",\n \"tools.run_flow(flow, store, flags) else: # Needed only for compatibility with Python 2.6 credentials\",\n \"for label in labels: print ('Label id: %s - Label name: %s' %\",\n \"__future__ import print_function import httplib2 import os import sys import pickle from apiclient\",\n \"from oauth2client import tools from oauth2client.file import Storage try: import argparse flags =\",\n \"DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.'\",\n \"delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE =\",\n \"labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__\",\n \"flow is completed to obtain the new credentials. Returns: Credentials, the obtained credential.\",\n \"been stored, or if the stored credentials are invalid, the OAuth2 flow is\",\n \"os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid:\",\n \"Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to ' + credential_path) return\",\n \"'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for label in labels:\",\n \"previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME\",\n \"= store.get() if not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent =\",\n \"apiclient import errors from oauth2client import client from oauth2client import tools from oauth2client.file\",\n \"storage. If nothing has been stored, or if the stored credentials are invalid,\",\n \"OAuth2 flow is completed to obtain the new credentials. Returns: Credentials, the obtained\",\n \"compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to ' +\",\n \"print ('An error occurred: %s' % error) def main(): credentials = get_credentials() http\",\n \"discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for label in\",\n \"= APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed only\",\n \"label_id) except errors.HttpError as error: print ('An error occurred: %s' % error) def\",\n \"only for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials to\",\n \"('Label with id: %s deleted successfully.' % label_id) except errors.HttpError as error: print\",\n \"Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage. If nothing has been\",\n \"Credentials, the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if\",\n \"to obtain the new credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir =\",\n \"credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow,\",\n \"ImportError: flags = None # If modifying these scopes, delete your previously saved\",\n \"label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as error: print ('An error occurred: %s'\",\n \"response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label in labels: print ('Label\",\n \"= tools.run(flow, store) print('Storing credentials to ' + credential_path) return credentials def GetLabels(service,\",\n \"get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage. If nothing has been stored, or\",\n \"Needed only for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing credentials\",\n \"is completed to obtain the new credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\"\",\n \"response['labels'] \\\"\\\"\\\" for label in labels: print ('Label id: %s - Label name:\",\n \"flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these scopes,\",\n \"labels = response['labels'] \\\"\\\"\\\" for label in labels: print ('Label id: %s -\",\n \"except errors.HttpError as error: print ('An error occurred: %s' % error) def DeleteLabel(service,\",\n \"If nothing has been stored, or if the stored credentials are invalid, the\",\n \"~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials():\",\n \"labels: print ('Label id: %s - Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\"\",\n \"'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets valid user credentials from storage. If nothing has\",\n \"%s - Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError\",\n \"= service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label in labels: print ('Label id:\",\n \"your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json'\",\n \"('An error occurred: %s' % error) def main(): credentials = get_credentials() http =\",\n \"valid user credentials from storage. If nothing has been stored, or if the\",\n \"% (label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as error: print ('An error\",\n \"flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: # Needed\",\n \"+ credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels =\",\n \"service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for\",\n \"saved credentials # at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME =\",\n \"# Needed only for compatibility with Python 2.6 credentials = tools.run(flow, store) print('Storing\",\n \"at ~/.credentials/gmail-python-quickstart.json SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def\",\n \"credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for\",\n \"# If modifying these scopes, delete your previously saved credentials # at ~/.credentials/gmail-python-quickstart.json\",\n \"in labels: print ('Label id: %s - Label name: %s' % (label['id'], label['name']))\",\n \"invalid, the OAuth2 flow is completed to obtain the new credentials. Returns: Credentials,\",\n \"the OAuth2 flow is completed to obtain the new credentials. Returns: Credentials, the\",\n \"('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute()\",\n \"os import sys import pickle from apiclient import discovery from apiclient import errors\",\n \"service.users().labels().list(userId=user_id).execute() labels = response['labels'] \\\"\\\"\\\" for label in labels: print ('Label id: %s\",\n \"import os import sys import pickle from apiclient import discovery from apiclient import\",\n \"except errors.HttpError as error: print ('An error occurred: %s' % error) def main():\",\n \"return labels except errors.HttpError as error: print ('An error occurred: %s' % error)\",\n \"errors from oauth2client import client from oauth2client import tools from oauth2client.file import Storage\",\n \"% error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id:\",\n \"error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1',\",\n \"credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir,\",\n \"in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if\",\n \"stored credentials are invalid, the OAuth2 flow is completed to obtain the new\",\n \"credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir)\",\n \"os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path)\",\n \"\\\"\\\"\\\" for label in labels: print ('Label id: %s - Label name: %s'\",\n \"store = Storage(credential_path) credentials = store.get() if not credentials or credentials.invalid: flow =\",\n \"error) def DeleteLabel(service, user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s\",\n \"\\\"\\\"\\\" return labels except errors.HttpError as error: print ('An error occurred: %s' %\",\n \"if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials =\",\n \"obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir = os.path.join(home_dir, '.credentials') if not os.path.exists(credential_dir):\",\n \"= client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags)\",\n \"SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store, flags) else: #\",\n \"- Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as\",\n \"user credentials from storage. If nothing has been stored, or if the stored\",\n \"try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If\",\n \"userId) for label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service,\",\n \"id: %s deleted successfully.' % label_id) except errors.HttpError as error: print ('An error\",\n \"import pickle from apiclient import discovery from apiclient import errors from oauth2client import\",\n \"\\\"\\\"\\\"Gets valid user credentials from storage. If nothing has been stored, or if\",\n \"'.credentials') if not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials\",\n \"user_id, label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' %\",\n \"apiclient import discovery from apiclient import errors from oauth2client import client from oauth2client\",\n \"= discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId) for label\",\n \"store, flags) else: # Needed only for compatibility with Python 2.6 credentials =\",\n \"except ImportError: flags = None # If modifying these scopes, delete your previously\",\n \"id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id) except errors.HttpError as\",\n \"label_id): try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id)\",\n \"id: %s - Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels except\",\n \"oauth2client import client from oauth2client import tools from oauth2client.file import Storage try: import\",\n \"not os.path.exists(credential_dir): os.makedirs(credential_dir) credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get()\",\n \"stored, or if the stored credentials are invalid, the OAuth2 flow is completed\",\n \"service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id) except errors.HttpError\",\n \"deleted successfully.' % label_id) except errors.HttpError as error: print ('An error occurred: %s'\",\n \"credentials from storage. If nothing has been stored, or if the stored credentials\",\n \"credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials\",\n \"import errors from oauth2client import client from oauth2client import tools from oauth2client.file import\",\n \"error occurred: %s' % error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http())\",\n \"= GetLabels(service, userId) for label in labels: if (label['type'] == 'user'): print('Deleting label:',\",\n \"the new credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir = os.path.expanduser('~') credential_dir\",\n \"http = credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels =\",\n \"pickle from apiclient import discovery from apiclient import errors from oauth2client import client\",\n \"as error: print ('An error occurred: %s' % error) def DeleteLabel(service, user_id, label_id):\",\n \"credentials.authorize(httplib2.Http()) service = discovery.build('gmail', 'v1', http=http) userId = 'me' labels = GetLabels(service, userId)\",\n \"completed to obtain the new credentials. Returns: Credentials, the obtained credential. \\\"\\\"\\\" home_dir\",\n \"import sys import pickle from apiclient import discovery from apiclient import errors from\",\n \"import discovery from apiclient import errors from oauth2client import client from oauth2client import\",\n \"not credentials or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags:\",\n \"from oauth2client import client from oauth2client import tools from oauth2client.file import Storage try:\",\n \"try: service.users().labels().delete(userId=user_id, id=label_id).execute() print ('Label with id: %s deleted successfully.' % label_id) except\",\n \"Label name: %s' % (label['id'], label['name'])) \\\"\\\"\\\" return labels except errors.HttpError as error:\",\n \"flags) else: # Needed only for compatibility with Python 2.6 credentials = tools.run(flow,\",\n \"== 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id']) if __name__ == '__main__': main()\",\n \"from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags\",\n \"argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except ImportError: flags = None # If modifying these\",\n \"print ('Label with id: %s deleted successfully.' % label_id) except errors.HttpError as error:\",\n \"label in labels: if (label['type'] == 'user'): print('Deleting label:', label['name']) DeleteLabel(service, userId, label['id'])\",\n \"credential_path) return credentials def GetLabels(service, user_id): try: response = service.users().labels().list(userId=user_id).execute() labels = response['labels']\",\n \"SCOPES = 'https://www.googleapis.com/auth/gmail.labels' CLIENT_SECRET_FILE = 'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \\\"\\\"\\\"Gets\",\n \"%s' % error) def main(): credentials = get_credentials() http = credentials.authorize(httplib2.Http()) service =\",\n \"credential_path = os.path.join(credential_dir, 'gmail-python-quickstart.json') store = Storage(credential_path) credentials = store.get() if not credentials\",\n \"import tools from oauth2client.file import Storage try: import argparse flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args() except\",\n \"flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials = tools.run_flow(flow, store,\"\n]","isConversational":false}}},{"rowIdx":284,"cells":{"ngram":{"kind":"list like","value":["halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' %","('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ##","('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32),","PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1","return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' % obj.format_revision)","## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32),","('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2","('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED","== 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this","sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision","halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' %","sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!')","## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32),","('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64),","PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1","('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32),","UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif","('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32),","sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found","('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64),","halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32),","('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32),","('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0:","('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64),","('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0:","('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ##","('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64),","('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64),","## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32),","('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision ==","if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1","1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug:","('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT","ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return","## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def","np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32),","halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found","UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else:","('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32),","% obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES,","('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32),","('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT","if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning","if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit()","('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32),","ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32)","ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj):","if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1:","print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1')","elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d,","print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!'","('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32),","('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ])","== 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if","ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return","]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR,","('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if","('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32),","obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2')","('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32),","('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32),","('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)),","== 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug:","('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ##","if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2","== 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this","print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!'","('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 =","email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0:","ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)),","## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32),","('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32),","('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ##","halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2","import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32),","import numpy as np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)),","('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)),","('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ])","obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email","('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)),","('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)),","('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64),","('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)),","2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is","('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64),","ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32),","HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies ==","('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32),","('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64),","== 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision","('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32),","('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)),","('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32),","0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning","('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64),","('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32),","('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64),","this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if","('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64),","## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32),","obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if","('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32),","if this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1:","('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if","('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision","('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64),","#('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32),","0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision ==","as np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)),","('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32),","('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT","('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32),","('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies","('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32),","return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision)","print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies","numpy as np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)),","('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ##","## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32),","('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32),","me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED","('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)),","('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES","('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32),","('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32),","halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32),","('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32),","return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else:","ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32),","('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64),","obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if","== 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug:","obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if","obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE","('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT","np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32),","]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32),","elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d,","0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning","halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32),","halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit()","('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 =","def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE","('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies ==","print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1')","halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' % obj.format_revision) sys.exit()","elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit()","obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if","('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32),","1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision ==","('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)),","else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit() elif","('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32),","ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32),","('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ##","getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!')","= np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32),","('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32),","obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif","('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32),","if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1:","is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision","obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2:","1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is","('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32),","obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif","('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64),","elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision ==","('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1","('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32),",">2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision ==","## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)),","print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return","== 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision","obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email","ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32),","]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32),","sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32),"],"string":"[\n \"halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' %\",\n \"('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ##\",\n \"('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32),\",\n \"PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1\",\n \"return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' % obj.format_revision)\",\n \"## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32),\",\n \"('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2\",\n \"('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED\",\n \"== 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this\",\n \"sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision\",\n \"halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' %\",\n \"sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!')\",\n \"## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32),\",\n \"('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64),\",\n \"PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1\",\n \"('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32),\",\n \"UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif\",\n \"('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32),\",\n \"sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found\",\n \"('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64),\",\n \"halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32),\",\n \"('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32),\",\n \"('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0:\",\n \"('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64),\",\n \"('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0:\",\n \"('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ##\",\n \"('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64),\",\n \"('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64),\",\n \"## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32),\",\n \"('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision ==\",\n \"if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1\",\n \"1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug:\",\n \"('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT\",\n \"ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return\",\n \"## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def\",\n \"np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32),\",\n \"halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found\",\n \"UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else:\",\n \"('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32),\",\n \"% obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES,\",\n \"('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32),\",\n \"('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT\",\n \"if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning\",\n \"if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit()\",\n \"('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32),\",\n \"ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32)\",\n \"ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj):\",\n \"if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1:\",\n \"print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halostruct1')\",\n \"elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d,\",\n \"print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!'\",\n \"('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32),\",\n \"('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ])\",\n \"== 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if\",\n \"ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return\",\n \"]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR,\",\n \"('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if\",\n \"('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32),\",\n \"obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2')\",\n \"('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32),\",\n \"('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32),\",\n \"('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)),\",\n \"== 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug:\",\n \"('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ##\",\n \"if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2\",\n \"== 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this\",\n \"print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!'\",\n \"('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 =\",\n \"email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0:\",\n \"ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)),\",\n \"## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32),\",\n \"('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32),\",\n \"('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ##\",\n \"halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2\",\n \"import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32),\",\n \"import numpy as np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)),\",\n \"('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)),\",\n \"('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ])\",\n \"obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email\",\n \"('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)),\",\n \"('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)),\",\n \"('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64),\",\n \"('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)),\",\n \"2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is\",\n \"('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64),\",\n \"ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32),\",\n \"HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies ==\",\n \"('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32),\",\n \"('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64),\",\n \"== 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision\",\n \"('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32),\",\n \"('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)),\",\n \"('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32),\",\n \"0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning\",\n \"('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64),\",\n \"('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32),\",\n \"('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64),\",\n \"this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if\",\n \"('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64),\",\n \"## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32),\",\n \"obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if\",\n \"('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32),\",\n \"if this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1:\",\n \"('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if\",\n \"('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision\",\n \"('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64),\",\n \"#('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32),\",\n \"0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision ==\",\n \"as np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)),\",\n \"('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32),\",\n \"('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT\",\n \"('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32),\",\n \"('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies\",\n \"('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32),\",\n \"return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision)\",\n \"print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies\",\n \"numpy as np import sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)),\",\n \"('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ##\",\n \"## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32),\",\n \"('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32),\",\n \"me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED\",\n \"('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)),\",\n \"('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES\",\n \"('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32),\",\n \"('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32), ('J',np.float32,(3,)), ('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32),\",\n \"halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32),\",\n \"('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32),\",\n \"return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else:\",\n \"ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32),\",\n \"('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64),\",\n \"obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if\",\n \"== 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug:\",\n \"obj.format_revision == 2: if obj.debug: print('returning halostruct2') return halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if\",\n \"obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE\",\n \"('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT\",\n \"np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32),\",\n \"]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32),\",\n \"elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d,\",\n \"0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning\",\n \"halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32),\",\n \"halostruct2 else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit()\",\n \"('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 =\",\n \"def getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE\",\n \"('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32), ('peak_density',np.float32), ('av_density',np.float32), ]) def getRSformat(obj): if obj.galaxies ==\",\n \"print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if obj.debug: print('returning halogalaxystruct1')\",\n \"halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' % obj.format_revision) sys.exit()\",\n \"elif obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit()\",\n \"obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1: if\",\n \"('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32),\",\n \"1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision ==\",\n \"('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)),\",\n \"else: print('found HALO_FORMAT_REVISION=%d, if this is >2 email me!' % obj.format_revision) sys.exit() elif\",\n \"('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32),\",\n \"ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32),\",\n \"('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ##\",\n \"getRSformat(obj): if obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!')\",\n \"= np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32),\",\n \"('energy',np.float32), ('spin',np.float32), ('alt_m',np.float32,(4,)), ('Xoff',np.float32), ('Voff',np.float32), ('b_to_a',np.float32), ('c_to_a',np.float32), ('A',np.float32,(3,)), ('b_to_a2',np.float32), ('c_to_a2',np.float32), ('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32),\",\n \"obj.galaxies == 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif\",\n \"('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32), ('rvmax',np.float32), ('rs',np.float32), ('klypin_rs',np.float32), ('vrms',np.float32),\",\n \"if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif obj.format_revision == 1:\",\n \"is >2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision\",\n \"obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision == 2:\",\n \"1: if obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is\",\n \"('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32), ('type',np.int32), ('sm',np.float32), ('gas',np.float32), ('bh',np.float32),\",\n \"obj.galaxies == 1: if obj.format_revision == 0: print('OUTDATED ROCKSTAR-GALAXIES, PLEASE UPDATE!') sys.exit() elif\",\n \"('A2',np.float32,(3,)), ('bullock_spin',np.float32), ('kin_to_pot',np.float32), ('m_pe_b',np.float32), ('m_pe_d',np.float32), ('halfmass_radius',np.float32), #('dummy1',np.float32), ## ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64),\",\n \"elif obj.format_revision == 1: if obj.debug: print('returning halostruct1') return halostruct1 elif obj.format_revision ==\",\n \"('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1\",\n \"('min_bulkvel_err',np.float32) ]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32),\",\n \">2 email me!' % obj.format_revision) sys.exit() elif obj.galaxies == 1: if obj.format_revision ==\",\n \"## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32) ]) ## ROCKSTAR-GALAXIES ## halogalaxystruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)),\",\n \"print('returning halostruct1') return halostruct1 elif obj.format_revision == 2: if obj.debug: print('returning halostruct2') return\",\n \"== 0: if obj.format_revision == 0: print('OUTDATED ROCKSTAR, PLEASE UPDATE!') sys.exit() elif obj.format_revision\",\n \"obj.debug: print('returning halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email\",\n \"ALIGNMENT ('num_p',np.int64), ('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err',np.float32), ('min_bulkvel_err',np.float32),\",\n \"]) halostruct2 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32), ('vmax_r',np.float32), ('mgrav',np.float32), ('vmax',np.float32),\",\n \"sys ## ROCKSTAR ## halostruct1 = np.dtype([('id',np.int64), ('pos',np.float32,(6,)), ('corevel',np.float32,(3,)), ('bulkvel',np.float32,(3,)), ('m',np.float32), ('r',np.float32), ('child_r',np.float32),\"\n]","isConversational":false}}},{"rowIdx":285,"cells":{"ngram":{"kind":"list like","value":["def location(self): \"\"\" Retrieve the location of an event :return: location :rtype: str","describing the event :rtype: str \"\"\" return (\"| \" + self.begin_date + self.end_date","= self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @property def","the wiki user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str","args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki =","EntropiaEvent: \"\"\" Parses an ics Event and converts it to an entropia-wiki suitable","page :type past_events: list :param wiki_user: bot user for the wiki :type wiki_user:","! style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\ \"\"\"","wiki archive page :param past_events: the past events that were not added to","be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" )","bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN -->","| Datum !! style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER =","ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as error: print(\"Please have a","not in line: deradicalised += \"\\n\"+line return deradicalised def main(): \"\"\" :return: None","event.name: description = \"N.A.\" else: description = event.name return description def __str__(self): \"\"\"","the location of an event :return: location :rtype: str \"\"\" locations = {","ics_url, file, wiki, debug = get_args() event_strings = [] past_events = [] if","datetime from ics import Calendar from mwclient import Site from dateutil.tz import tzlocal","the start of the event :rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property","\"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\"","= \"\"\" <!-- This text is automatically generated by the ics2entropiawiki bot, everything","'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event =","raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\" :param ics: input","= \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung'''","appends past events to the \"Vergangene_Termine\" Site \"\"\" import locale import configparser import","args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile:","locations[location.lower()] return location @property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time :rtype:","help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which","location(self): \"\"\" Retrieve the location of an event :return: location :rtype: str \"\"\"","dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under","\"\"\" import locale import configparser import re import requests from argparse import ArgumentParser","in text: append_list = ( '\\n' + LINE_SEPARATOR + str(event) ) text =","path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\") page.purge()","#!/usr/bin/env python3 # -*- coding: utf-8 -*- \"\"\"ics2entropiawiki Read an ics file with","+ str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 *","retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument(",":return: Entropia-Wiki formatted end time :rtype: str \"\"\" end_date = \"\" if self.endtime","--> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" !","wiki_archive: str :return: None :rtype: None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw)","from dateutil.tz import tzlocal BOTWARNING = \"\"\" <!-- This text is automatically generated","\"\"\" :return: The event's description :rtype: str \"\"\" links = None wiki =","event.name return description def __str__(self): \"\"\" :return: A wiki line describing the event","year_header in text: append_list = ( '\\n' + LINE_SEPARATOR + str(event) ) text","= event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve","pass class EntropiaEvent: \"\"\" Parses an ics Event and converts it to an","args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config =","$ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the \"Termine\"","site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0 for event","editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\"",") def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\" past events to","else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\" + TABLE_HEADER","+ self.end_date + \" || \" + self.start_time + \" || \" +","Days to the start of the event :rtype: datetime.timedelta \"\"\" return self.endtime -","list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\",","[] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8'","in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events","class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER =","__init__(self, event): \"\"\" :param event: The event to be evaluated :type event: ics.event.Event","]+text[last_table_position:] else: append_list = ( 3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER +","debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine:","help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument(","\"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line",":param wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None \"\"\" site","not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'],","metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\",","'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser()","description = event.name return description def __str__(self): \"\"\" :return: A wiki line describing","\"\"\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self):","+ LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine =","the wiki :type wiki_user: str :param wiki_pw: password for the wiki user :type","def get_args(): \"\"\" Retrieve arguments from the command line, the config file respectively","None :rtype: None \"\"\" ics_url, file, wiki, debug = get_args() event_strings = []","= BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\" +","append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\"","help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument(","if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events,","get_args(): \"\"\" Retrieve arguments from the command line, the config file respectively :return:","metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki","The event's description :rtype: str \"\"\" links = None wiki = None event","+ \" || \" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\"","LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\" Parses","self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\" past events","+ self.start_time + \" || \" + self.location + \" || \" +","Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\"","|| \" + self.location + \" || \" + self.description ) def append_past_events(past_events,","line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line return deradicalised","\"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \" if self.event.location: location = self.event.location if","wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\"","links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description",") args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file","input file :type ics: str :return: file with remove radicale_headers \"\"\" deradicalised =","None :rtype: None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive]","wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None","locale.Error: pass class EntropiaEvent: \"\"\" Parses an ics Event and converts it to","= self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\" :return: The event's description :rtype:",") parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\",","parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\",",":rtype: None \"\"\" ics_url, file, wiki, debug = get_args() event_strings = [] past_events","@property def days_to_event(self): \"\"\" :return: Days to the start of the event :rtype:","user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\",","from command line, config file :rtype: list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\",","sample config provided with the package\") raise error return ics_url, file, wiki, debug","self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self):","links = None wiki = None event = self.event if event.description: links =","past events that were not added to the events page :type past_events: list","debug def deradicalise_ical(ics): \"\"\" :param ics: input file :type ics: str :return: file","event: ics.event.Event \"\"\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property","page.text().split('\\n') last_table_position = 0 for event in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y'))","everything you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch","end_date = \"\" if self.endtime - self.begintime > timedelta(days=1): end_date = \" -","|width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \",","end time :rtype: str \"\"\" end_date = \"\" if self.endtime - self.begintime >","\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error:","> timedelta(days=1): end_date = \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property","!! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\"","= re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki:","not added to the events page :type past_events: list :param wiki_user: bot user","event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the location of an","an event :return: location :rtype: str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", }","WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\"","None \"\"\" ics_url, file, wiki, debug = get_args() event_strings = [] past_events =","= re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description =","Site from dateutil.tz import tzlocal BOTWARNING = \"\"\" <!-- This text is automatically","append_list = ( 3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n' +","ics file with the entropia events and insert them in to the entropia","TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site","the \"new\" past events to the wiki archive page :param past_events: the past","None wiki = None event = self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description)","ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\",","elif not event.name: description = \"N.A.\" else: description = event.name return description def",") parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args() configfile =",":rtype: str \"\"\" start_time = \" \" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\")","ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\" :param ics: input file :type ics:","border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = (",":param ics: input file :type ics: str :return: file with remove radicale_headers \"\"\"","you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert.","cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\",","to the \"Vergangene_Termine\" Site \"\"\" import locale import configparser import re import requests","locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted","the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in",":rtype: str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \"",":rtype: str \"\"\" end_date = \"\" if self.endtime - self.begintime > timedelta(days=1): end_date","index, txtline in enumerate(text): if txtline == '|}': last_table_position = index if str(event)","if year_header in text: append_list = ( '\\n' + LINE_SEPARATOR + str(event) )","\"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which the ICS-file can be retrieved\", metavar=\"URL\",","BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER)","\" + self.begin_date + self.end_date + \" || \" + self.start_time + \"","= None wiki = None event = self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\",","help=\"The URL under which the ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\",","def deradicalise_ical(ics): \"\"\" :param ics: input file :type ics: str :return: file with","\"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']]","ics import Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING =","past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline","args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, }","self.start_time + \" || \" + self.location + \" || \" + self.description",") LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\"","line, config file :rtype: list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\",","Entropia-Wiki formatted end time :rtype: str \"\"\" end_date = \"\" if self.endtime -","under which the ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\",","config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as error: print(\"Please have a look at","%d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\" :return: Days to the start of",":return: Entropia-Wiki formatted begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def","= index if str(event) in text: continue if year_header in text: append_list =","= parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki =",":param past_events: the past events that were not added to the events page","+ self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\" past","URL under which the ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\",","ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN","\"\"\"ics2entropiawiki Read an ics file with the entropia events and insert them in","\"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug:","archive page :type wiki_archive: str :return: None :rtype: None \"\"\" site = Site('entropia.de',","append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\" past events to the wiki","error: print(\"Please have a look at the sample config provided with the package\")","suitable form \"\"\" def __init__(self, event): \"\"\" :param event: The event to be","past_events: the past events that were not added to the events page :type","= args.configfile ics_url = args.ics_url file = args.local_file wiki = { 'user': args.wiki_user,","dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" )","= event.name return description def __str__(self): \"\"\" :return: A wiki line describing the","def main(): \"\"\" :return: None :rtype: None \"\"\" ics_url, file, wiki, debug =","it to an entropia-wiki suitable form \"\"\" def __init__(self, event): \"\"\" :param event:","to the \"Termine\" Wiki page and appends past events to the \"Vergangene_Termine\" Site","time :rtype: str \"\"\" end_date = \"\" if self.endtime - self.begintime > timedelta(days=1):","start_time(self): \"\"\" :return: The starting time of the event :rtype: str \"\"\" start_time","def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a.,","'\\n' + LINE_SEPARATOR + '\\n' + str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list,","with remove radicale_headers \"\"\" deradicalised = \"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:'","last_table_position = 0 for event in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for","wiki_archive): \"\"\" Append the \"new\" past events to the wiki archive page :param","if 'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line return deradicalised def main(): \"\"\"","site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\") page.purge() if __name__ == '__main__': main()","+ self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\" :return: Days to the","= event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the location of","parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki","ics.event.Event \"\"\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def","wiki_pw, wiki_archive): \"\"\" Append the \"new\" past events to the wiki archive page","parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page',","import configparser import re import requests from argparse import ArgumentParser from datetime import","and converts it to an entropia-wiki suitable form \"\"\" def __init__(self, event): \"\"\"","datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check if the event lies in the","+ \" || \" + self.location + \" || \" + self.description )","the past events that were not added to the events page :type past_events:","BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier","\"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !!","text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from the command line, the","-*- \"\"\"ics2entropiawiki Read an ics file with the entropia events and insert them","events to the wiki archive page :param past_events: the past events that were","import timedelta, datetime from ics import Calendar from mwclient import Site from dateutil.tz","from argparse import ArgumentParser from datetime import timedelta, datetime from ics import Calendar","in the past to the \"Termine\" Wiki page and appends past events to","event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\"","the event lies in the past :rtype: bool \"\"\" return self.days_to_event < timedelta(days=0)","A wiki line describing the event :rtype: str \"\"\" return (\"| \" +","archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args()","import tzlocal BOTWARNING = \"\"\" <!-- This text is automatically generated by the","file :type ics: str :return: file with remove radicale_headers \"\"\" deradicalised = \"\"","end_date @property def days_to_event(self): \"\"\" :return: Days to the start of the event","wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\" past events to the wiki archive","'\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list =","BOTWARNING = \"\"\" <!-- This text is automatically generated by the ics2entropiawiki bot,","self.location + \" || \" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive):","None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text =","debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"]","deradicalised += \"\\n\"+line return deradicalised def main(): \"\"\" :return: None :rtype: None \"\"\"","past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\" + TABLE_HEADER +","{ \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \" if self.event.location: location = self.event.location","__str__(self): \"\"\" :return: A wiki line describing the event :rtype: str \"\"\" return","= args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page':","utf-8 -*- \"\"\"ics2entropiawiki Read an ics file with the entropia events and insert","for index, txtline in enumerate(text): if txtline == '|}': last_table_position = index if","default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL",") text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from the","the past :rtype: bool \"\"\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\"","try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as error: print(\"Please have","from mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \"\"\" <!-- This","location @property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time :rtype: str \"\"\"","can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\"","radicale_headers \"\"\" deradicalised = \"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in","in line: deradicalised += \"\\n\"+line return deradicalised def main(): \"\"\" :return: None :rtype:",":return: None :rtype: None \"\"\" ics_url, file, wiki, debug = get_args() event_strings =","event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive'])","str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \" if","except locale.Error: pass class EntropiaEvent: \"\"\" Parses an ics Event and converts it","+ \"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site =","enumerate(text): if txtline == '|}': last_table_position = index if str(event) in text: continue","python3 # -*- coding: utf-8 -*- \"\"\"ics2entropiawiki Read an ics file with the","mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \"\"\" <!-- This text","= Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was","start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\" :return: The event's description","print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine,","page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\") page.purge() if __name__ ==","def end_date(self): \"\"\" :return: Entropia-Wiki formatted end time :rtype: str \"\"\" end_date =","def start_time(self): \"\"\" :return: The starting time of the event :rtype: str \"\"\"","The event to be evaluated :type event: ics.event.Event \"\"\" self.event = event self.begintime","timedelta(days=0) @property def start_time(self): \"\"\" :return: The starting time of the event :rtype:","event :rtype: str \"\"\" start_time = \" \" if not self.event.all_day: start_time =","\"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0] elif not event.name: description = \"N.A.\"","self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links","|width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\",","respectively :return: Parsed arguments from command line, config file :rtype: list \"\"\" parser","events to the \"Vergangene_Termine\" Site \"\"\" import locale import configparser import re import","ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\",","= configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as","arguments from the command line, the config file respectively :return: Parsed arguments from","'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if","events that were not added to the events page :type past_events: list :param","description def __str__(self): \"\"\" :return: A wiki line describing the event :rtype: str","\"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'],","metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args() configfile","'\\n' + str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args():",":param event: The event to be evaluated :type event: ics.event.Event \"\"\" self.event =","!! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\"","\"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit'''","days_to_event(self): \"\"\" :return: Days to the start of the event :rtype: datetime.timedelta \"\"\"","]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from the command line, the config","event.description) if links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description =","wiki: description = wiki[0] elif not event.name: description = \"N.A.\" else: description =","Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER =","vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD","and everything you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot","help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\",","insert them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini","Append the \"new\" past events to the wiki archive page :param past_events: the","--config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the \"Termine\" Wiki page","= \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0] elif not event.name: description =","= page.text().split('\\n') last_table_position = 0 for event in past_events: year_header = \"== {}",":type ics: str :return: file with remove radicale_headers \"\"\" deradicalised = \"\" for","locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \" if self.event.location: location","Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt","site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\") page.purge() if","def __str__(self): \"\"\" :return: A wiki line describing the event :rtype: str \"\"\"","\" || \" + self.location + \" || \" + self.description ) def","location :rtype: str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \"","str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki formatted end","time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki","\" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\"","command line, config file :rtype: list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\",","\"\"\" return (\"| \" + self.begin_date + self.end_date + \" || \" +","\"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE'","of an event :return: location :rtype: str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\",","\"N.A.\" else: description = event.name return description def __str__(self): \"\"\" :return: A wiki","+ year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n' + str(event) +","\"--url\", dest=\"ics_url\", help=\"The URL under which the ICS-file can be retrieved\", metavar=\"URL\", )",":return: file with remove radicale_headers \"\"\" deradicalised = \"\" for line in ics.splitlines():","self.event.location: location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location","self.begintime > timedelta(days=1): end_date = \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date","@property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time :rtype: str \"\"\" return","{| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER","the event :rtype: str \"\"\" return (\"| \" + self.begin_date + self.end_date +",":type past_events: list :param wiki_user: bot user for the wiki :type wiki_user: str","This text is automatically generated by the ics2entropiawiki bot, everything you write and","the config file respectively :return: Parsed arguments from command line, config file :rtype:","<!-- This text is automatically generated by the ics2entropiawiki bot, everything you write",":return: Check if the event lies in the past :rtype: bool \"\"\" return","\"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" )","event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the location of an event :return: location","= \"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised +=",") else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\" +","else: description = event.name return description def __str__(self): \"\"\" :return: A wiki line","past :rtype: bool \"\"\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\" :return:","config file :rtype: list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\",","page :param past_events: the past events that were not added to the events","\"\"\" def __init__(self, event): \"\"\" :param event: The event to be evaluated :type","import re import requests from argparse import ArgumentParser from datetime import timedelta, datetime","= { \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \" if self.event.location: location =","sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" +","\"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR","bool \"\"\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\" :return: The starting","\"\\n\"+line return deradicalised def main(): \"\"\" :return: None :rtype: None \"\"\" ics_url, file,","print(\"Please have a look at the sample config provided with the package\") raise","ics: input file :type ics: str :return: file with remove radicale_headers \"\"\" deradicalised","TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene","hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {|","user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\",","text: append_list = ( '\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list,",":rtype: None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text","file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\",","the ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local ics","in enumerate(text): if txtline == '|}': last_table_position = index if str(event) in text:","- \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\" :return: Days",":rtype: str \"\"\" return (\"| \" + self.begin_date + self.end_date + \" ||","str(event) in text: continue if year_header in text: append_list = ( '\\n' +","str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve","year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline ==","self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\" :return: Days to the start","\"\"\" <!-- This text is automatically generated by the ics2entropiawiki bot, everything you",":return: Parsed arguments from command line, config file :rtype: list \"\"\" parser =","else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in","ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n' + str(event) + '\\n|}' ) text",") parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki",":rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki formatted","\"\"\" :return: Check if the event lies in the past :rtype: bool \"\"\"","EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event)","path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0 for","= [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result =","remove radicale_headers \"\"\" deradicalised = \"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not","datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check if","def is_past_event(self): \"\"\" :return: Check if the event lies in the past :rtype:",":param wiki_user: bot user for the wiki :type wiki_user: str :param wiki_pw: password","if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and","ics2entropiawiki bot, everything you write and everything you edit WILL BE OVERWRITTEN Dieser","str \"\"\" end_date = \"\" if self.endtime - self.begintime > timedelta(days=1): end_date =","list :param wiki_user: bot user for the wiki :type wiki_user: str :param wiki_pw:","wiki, debug def deradicalise_ical(ics): \"\"\" :param ics: input file :type ics: str :return:","help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument(","the events page :type past_events: list :param wiki_user: bot user for the wiki","bot user for the wiki :type wiki_user: str :param wiki_pw: password for the","txtline in enumerate(text): if txtline == '|}': last_table_position = index if str(event) in","str \"\"\" return (\"| \" + self.begin_date + self.end_date + \" || \"","= site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0 for event in past_events: year_header","the event :rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\"","index if str(event) in text: continue if year_header in text: append_list = (","if str(event) in text: continue if year_header in text: append_list = ( '\\n'","file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which the","requests from argparse import ArgumentParser from datetime import timedelta, datetime from ics import","str \"\"\" start_time = \" \" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return","text: continue if year_header in text: append_list = ( '\\n' + LINE_SEPARATOR +","everything you write and everything you edit WILL BE OVERWRITTEN Dieser Text ist","converts it to an entropia-wiki suitable form \"\"\" def __init__(self, event): \"\"\" :param","\"\" if self.endtime - self.begintime > timedelta(days=1): end_date = \" - \" +","the package\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\" :param","\"\"\" :param ics: input file :type ics: str :return: file with remove radicale_headers","wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug","for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line return","Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\")","file with remove radicale_headers \"\"\" deradicalised = \"\" for line in ics.splitlines(): if","an entropia-wiki suitable form \"\"\" def __init__(self, event): \"\"\" :param event: The event","- self.begintime > timedelta(days=1): end_date = \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return","command line, the config file respectively :return: Parsed arguments from command line, config","return self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\" :return: The starting time of",") parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's","wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\") page.purge() if __name__",") parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive',","tzlocal BOTWARNING = \"\"\" <!-- This text is automatically generated by the ics2entropiawiki","wiki :type wiki_user: str :param wiki_pw: password for the wiki user :type wiki_pw:","Parsed arguments from command line, config file :rtype: list \"\"\" parser = ArgumentParser()","wiki = config[\"wiki\"] except KeyError as error: print(\"Please have a look at the","\"[[Anfahrt|Entropia]]\", } location = \" \" if self.event.location: location = self.event.location if location.lower()","with the entropia events and insert them in to the entropia homepage wiki.","archive page :param past_events: the past events that were not added to the","Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert,","and appends past events to the \"Vergangene_Termine\" Site \"\"\" import locale import configparser","\"\"\" Retrieve arguments from the command line, the config file respectively :return: Parsed","\"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The","Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum'''","the \"Termine\" Wiki page and appends past events to the \"Vergangene_Termine\" Site \"\"\"","write and everything you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki","ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\"","parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE'","= 0 for event in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index,","the event :rtype: str \"\"\" start_time = \" \" if not self.event.all_day: start_time","entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the","args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki","[] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url)","ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort'''","\"\"\" start_time = \" \" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time","line: deradicalised += \"\\n\"+line return deradicalised def main(): \"\"\" :return: None :rtype: None","( 3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR +","|| \" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the","requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev:","which the ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument( \"-f\", \"--file\", dest=\"local_file\", help=\"Local","style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\"","[[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent:","description = \"N.A.\" else: description = event.name return description def __str__(self): \"\"\" :return:","class EntropiaEvent: \"\"\" Parses an ics Event and converts it to an entropia-wiki","page and appends past events to the \"Vergangene_Termine\" Site \"\"\" import locale import","wiki_user: bot user for the wiki :type wiki_user: str :param wiki_pw: password for","in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if","\"\"\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\" :return: The starting time","coding: utf-8 -*- \"\"\"ics2entropiawiki Read an ics file with the entropia events and","self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\" :return: The event's","str :return: None :rtype: None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page","event :return: location :rtype: str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location","metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which the ICS-file can","metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\",","locale import configparser import re import requests from argparse import ArgumentParser from datetime","generated by the ics2entropiawiki bot, everything you write and everything you edit WILL","locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\" Parses an ics Event and","wiki_user: str :param wiki_pw: password for the wiki user :type wiki_pw: str :param",") text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\n' +","main(): \"\"\" :return: None :rtype: None \"\"\" ics_url, file, wiki, debug = get_args()","generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER","-*- coding: utf-8 -*- \"\"\"ics2entropiawiki Read an ics file with the entropia events","< timedelta(days=0) @property def start_time(self): \"\"\" :return: The starting time of the event","ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event)","= Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position =","\"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki formatted end time","location = locations[location.lower()] return location @property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin","+ LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = (","= args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki","if the event lies in the past :rtype: bool \"\"\" return self.days_to_event <","= args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive,","config provided with the package\") raise error return ics_url, file, wiki, debug def",":type event: ics.event.Event \"\"\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone()","\"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page","Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0","{| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\"","Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class","formatted end time :rtype: str \"\"\" end_date = \"\" if self.endtime - self.begintime","\"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n')","the \"Vergangene_Termine\" Site \"\"\" import locale import configparser import re import requests from","automatically generated by the ics2entropiawiki bot, everything you write and everything you edit","\"Termine\" Wiki page and appends past events to the \"Vergangene_Termine\" Site \"\"\" import","\" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\" :return:","events and insert them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py","edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles","str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\"","entropia events and insert them in to the entropia homepage wiki. Example: $","in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \"\"\" :return: Entropia-Wiki","site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position","the command line, the config file respectively :return: Parsed arguments from command line,","\" + self.start_time + \" || \" + self.location + \" || \"","event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'],","argparse import ArgumentParser from datetime import timedelta, datetime from ics import Calendar from","by the ics2entropiawiki bot, everything you write and everything you edit WILL BE","+ \"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page =","\"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\"","from ics import Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING","= { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug =","deradicalised = \"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised","= config[\"wiki\"] except KeyError as error: print(\"Please have a look at the sample","self.end_date + \" || \" + self.start_time + \" || \" + self.location","= Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if","past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding","text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\n' + year_header","wiki user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return:","import locale import configparser import re import requests from argparse import ArgumentParser from","\"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\",","def __init__(self, event): \"\"\" :param event: The event to be evaluated :type event:","= EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) ) else:",":return: A wiki line describing the event :rtype: str \"\"\" return (\"| \"",":param wiki_pw: password for the wiki user :type wiki_pw: str :param wiki_archive: archive","start_time = \" \" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property","= config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as error: print(\"Please have a look","Parses an ics Event and converts it to an entropia-wiki suitable form \"\"\"","ics Event and converts it to an entropia-wiki suitable form \"\"\" def __init__(self,","for event in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in","style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\","site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot","to the start of the event :rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal())","event :rtype: str \"\"\" return (\"| \" + self.begin_date + self.end_date + \"","= \" \" if self.event.location: location = self.event.location if location.lower() in locations.keys(): location","Inserts events not in the past to the \"Termine\" Wiki page and appends","str :param wiki_pw: password for the wiki user :type wiki_pw: str :param wiki_archive:","in the past :rtype: bool \"\"\" return self.days_to_event < timedelta(days=0) @property def start_time(self):","links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0] elif","ArgumentParser from datetime import timedelta, datetime from ics import Calendar from mwclient import","\"\"\" :return: Entropia-Wiki formatted begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property","def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\" past events to the","3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n'","event's description :rtype: str \"\"\" links = None wiki = None event =","text = page.text().split('\\n') last_table_position = 0 for event in past_events: year_header = \"==","return deradicalised def main(): \"\"\" :return: None :rtype: None \"\"\" ics_url, file, wiki,","config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError","width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit !! Ort !!","manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\"","\"\"\" ics_url, file, wiki, debug = get_args() event_strings = [] past_events = []","wiki['archive']) termine = BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings) +","self.begin_date + self.end_date + \" || \" + self.start_time + \" || \"","\"\"\" :return: None :rtype: None \"\"\" ics_url, file, wiki, debug = get_args() event_strings","\"Vergangene_Termine\" Site \"\"\" import locale import configparser import re import requests from argparse","width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links:","args.configfile ics_url = args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass':","str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\n'","if self.event.location: location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return","= requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda","\"\"\" :return: Entropia-Wiki formatted end time :rtype: str \"\"\" end_date = \"\" if","configparser import re import requests from argparse import ArgumentParser from datetime import timedelta,","text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER","default=False ) args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file =","event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append(","(\"| \" + self.begin_date + self.end_date + \" || \" + self.start_time +","Wiki page and appends past events to the \"Vergangene_Termine\" Site \"\"\" import locale","events not in the past to the \"Termine\" Wiki page and appends past","\"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\" Parses an ics","cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit !!","event): \"\"\" :param event: The event to be evaluated :type event: ics.event.Event \"\"\"",") parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\",","OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell","import requests from argparse import ArgumentParser from datetime import timedelta, datetime from ics","description = wiki[0] elif not event.name: description = \"N.A.\" else: description = event.name","= [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding =","if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar","file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive':","except KeyError as error: print(\"Please have a look at the sample config provided","= site.pages[wiki['page']] if termine: page.save(termine, \"Terminbot was here\") page.purge() if __name__ == '__main__':","calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event)","args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page,","wiki = None event = self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki","dateutil.tz import tzlocal BOTWARNING = \"\"\" <!-- This text is automatically generated by","configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except","not in the past to the \"Termine\" Wiki page and appends past events","timedelta, datetime from ics import Calendar from mwclient import Site from dateutil.tz import","The starting time of the event :rtype: str \"\"\" start_time = \" \"","try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\" Parses an ics Event","and insert them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config","if links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0]","args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url","re import requests from argparse import ArgumentParser from datetime import timedelta, datetime from","( '\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list","\"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url =","event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR + str(event) )","self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check if the event lies","wiki line describing the event :rtype: str \"\"\" return (\"| \" + self.begin_date","is automatically generated by the ics2entropiawiki bot, everything you write and everything you","Datum !! style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\"","return end_date @property def days_to_event(self): \"\"\" :return: Days to the start of the","the entropia events and insert them in to the entropia homepage wiki. Example:","page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from the command line, the config file","* '\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n' +","start_time @property def description(self): \"\"\" :return: The event's description :rtype: str \"\"\" links","events page :type past_events: list :param wiki_user: bot user for the wiki :type","= wiki[0] elif not event.name: description = \"N.A.\" else: description = event.name return","str :return: file with remove radicale_headers \"\"\" deradicalised = \"\" for line in","= ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]],","= \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum","+ str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\"","to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not","form \"\"\" def __init__(self, event): \"\"\" :param event: The event to be evaluated","the past to the \"Termine\" Wiki page and appends past events to the","0 for event in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline","homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past","self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\" :return: The starting time of the","def description(self): \"\"\" :return: The event's description :rtype: str \"\"\" links = None","\"\"\" Retrieve the location of an event :return: location :rtype: str \"\"\" locations","location = \" \" if self.event.location: location = self.event.location if location.lower() in locations.keys():","from datetime import timedelta, datetime from ics import Calendar from mwclient import Site","+ \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass'])","ics: str :return: file with remove radicale_headers \"\"\" deradicalised = \"\" for line","\"-f\", \"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\",","from the command line, the config file respectively :return: Parsed arguments from command","config file respectively :return: Parsed arguments from command line, config file :rtype: list","= \" \" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def","import Site from dateutil.tz import tzlocal BOTWARNING = \"\"\" <!-- This text is","= ( '\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else:","in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\"","\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8')","event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name:","cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\",","page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0 for event in past_events:","\"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location = \" \" if self.event.location:","'\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n' + str(event)","\" || \" + self.start_time + \" || \" + self.location + \"","def days_to_event(self): \"\"\" :return: Days to the start of the event :rtype: datetime.timedelta","= \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}':","+= \"\\n\"+line return deradicalised def main(): \"\"\" :return: None :rtype: None \"\"\" ics_url,","metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki","= event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the location of an event :return:","+ '\\n' + LINE_SEPARATOR + '\\n' + str(event) + '\\n|}' ) text =","bot, everything you write and everything you edit WILL BE OVERWRITTEN Dieser Text","import ArgumentParser from datetime import timedelta, datetime from ics import Calendar from mwclient","= Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for",") parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which the ICS-file can be","+ LINE_SEPARATOR + '\\n' + str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:]","wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to","= \"N.A.\" else: description = event.name return description def __str__(self): \"\"\" :return: A","start of the event :rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def","time of the event :rtype: str \"\"\" start_time = \" \" if not","re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description = \"[\"+links[0]+\"","str \"\"\" links = None wiki = None event = self.event if event.description:","wiki, debug = get_args() event_strings = [] past_events = [] if file: calendar","be evaluated :type event: ics.event.Event \"\"\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime","user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return: None","Site \"\"\" import locale import configparser import re import requests from argparse import","timedelta(days=1): end_date = \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def","Event and converts it to an entropia-wiki suitable form \"\"\" def __init__(self, event):","event_strings = [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result","event = self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description)","file, wiki, debug = get_args() event_strings = [] past_events = [] if file:","style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER","\"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}': last_table_position","|| \" + self.start_time + \" || \" + self.location + \" ||","with the package\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\"","event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0] elif not event.name:","Retrieve arguments from the command line, the config file respectively :return: Parsed arguments","provided with the package\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics):",":return: location :rtype: str \"\"\" locations = { \"entropia\": \"[[Anfahrt|Entropia]]\", } location =","@property def location(self): \"\"\" Retrieve the location of an event :return: location :rtype:","of the event :rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self):","is_past_event(self): \"\"\" :return: Check if the event lies in the past :rtype: bool","event :rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return:","\"+event.name+\"]\" elif wiki: description = wiki[0] elif not event.name: description = \"N.A.\" else:","'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line return deradicalised def main(): \"\"\" :return:","LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING","file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar =","page :type wiki_archive: str :return: None :rtype: None \"\"\" site = Site('entropia.de', path='/')","config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as error: print(\"Please","location.lower() in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \"\"\" :return:","for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event:",":return: None :rtype: None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page =","import Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \"\"\"","hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\"","\"\"\" Parses an ics Event and converts it to an entropia-wiki suitable form","location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @property","= ( 3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR",":type wiki_archive: str :return: None :rtype: None \"\"\" site = Site('entropia.de', path='/') site.login(wiki_user,","\"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\"","+ \"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if","event lies in the past :rtype: bool \"\"\" return self.days_to_event < timedelta(days=0) @property","\"\"\" Append the \"new\" past events to the wiki archive page :param past_events:","\"new\" past events to the wiki archive page :param past_events: the past events","begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return:","Retrieve the location of an event :return: location :rtype: str \"\"\" locations =","KeyError as error: print(\"Please have a look at the sample config provided with","an ics Event and converts it to an entropia-wiki suitable form \"\"\" def","Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \"\"\" <!--","description :rtype: str \"\"\" links = None wiki = None event = self.event","event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the","file, wiki, debug def deradicalise_ical(ics): \"\"\" :param ics: input file :type ics: str","password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\",","self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the location","return start_time @property def description(self): \"\"\" :return: The event's description :rtype: str \"\"\"","\"\\n\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine","an ics file with the entropia events and insert them in to the","of the event :rtype: str \"\"\" start_time = \" \" if not self.event.all_day:","LINE_SEPARATOR + '\\n' + str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text))","wiki_pw: password for the wiki user :type wiki_pw: str :param wiki_archive: archive page","last_table_position = index if str(event) in text: continue if year_header in text: append_list","file with the entropia events and insert them in to the entropia homepage","+ str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING +","lies in the past :rtype: bool \"\"\" return self.days_to_event < timedelta(days=0) @property def","cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit !! Ort","past_events: list :param wiki_user: bot user for the wiki :type wiki_user: str :param","if self.endtime - self.begintime > timedelta(days=1): end_date = \" - \" + self.endtime.strftime(\"%a.,","\" if self.event.location: location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()]","past events to the \"Vergangene_Termine\" Site \"\"\" import locale import configparser import re","+ \" || \" + self.start_time + \" || \" + self.location +","wiki[0] elif not event.name: description = \"N.A.\" else: description = event.name return description","for the wiki :type wiki_user: str :param wiki_pw: password for the wiki user","'\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from","file respectively :return: Parsed arguments from command line, config file :rtype: list \"\"\"","as error: print(\"Please have a look at the sample config provided with the","return ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\" :param ics: input file :type","past events to the wiki archive page :param past_events: the past events that","not event.name: description = \"N.A.\" else: description = event.name return description def __str__(self):","continue if year_header in text: append_list = ( '\\n' + LINE_SEPARATOR + str(event)","} debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url =","= locations[location.lower()] return location @property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time","not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\" :return: The","append_list = ( '\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:]","Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event","self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\"","parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki = {","return description def __str__(self): \"\"\" :return: A wiki line describing the event :rtype:","Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the","entropia-wiki suitable form \"\"\" def __init__(self, event): \"\"\" :param event: The event to","automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\"",":type wiki_user: str :param wiki_pw: password for the wiki user :type wiki_pw: str","them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts","\"\"\" :return: Days to the start of the event :rtype: datetime.timedelta \"\"\" return","( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\"","} location = \" \" if self.event.location: location = self.event.location if location.lower() in","return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check if the event","else: append_list = ( 3 * '\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\n'","\" \" if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def description(self):","TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" |","\"\"\" deradicalised = \"\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line:","\"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR =","was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \"\"\" TABLE_HEADER = \"\"\"","calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text))","/etc/ics2entropiawiki/config.ini Inserts events not in the past to the \"Termine\" Wiki page and","Entropia-Wiki formatted begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self):","\"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url","\"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de',","\" || \" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append","have a look at the sample config provided with the package\") raise error","txtline == '|}': last_table_position = index if str(event) in text: continue if year_header","line, the config file respectively :return: Parsed arguments from command line, config file","style=\"border-collapse:collapse;\" width=\"100%\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere","starting time of the event :rtype: str \"\"\" start_time = \" \" if","text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from the command","= ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument(","wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\" +","+ TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine)","if location.lower() in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \"\"\"",":return: The event's description :rtype: str \"\"\" links = None wiki = None","\"\"\" links = None wiki = None event = self.event if event.description: links","Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\"","parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\",","+ \"\".join(event_strings) + \"\\n\" + \"\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/')","if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"]","deradicalised def main(): \"\"\" :return: None :rtype: None \"\"\" ics_url, file, wiki, debug","self.endtime = event._end_time.datetime.astimezone() @property def location(self): \"\"\" Retrieve the location of an event","@property def is_past_event(self): \"\"\" :return: Check if the event lies in the past",":rtype: str \"\"\" links = None wiki = None event = self.event if","dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' )","year_header + ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n' + str(event) + '\\n|}'","deradicalise_ical(ics): \"\"\" :param ics: input file :type ics: str :return: file with remove",":return: The starting time of the event :rtype: str \"\"\" start_time = \"","class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\" |","end_date = \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self):","|width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]]","past to the \"Termine\" Wiki page and appends past events to the \"Vergangene_Termine\"","return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki formatted end time :rtype:","border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\" | Datum !! style=\"width:50px;\" | Zeit","ics_url = args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw,","user for the wiki :type wiki_user: str :param wiki_pw: password for the wiki","parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which the ICS-file can be retrieved\",","return location @property def begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time :rtype: str","{} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}': last_table_position =","help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args =","= \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\" Parses an","to be evaluated :type event: ics.event.Event \"\"\" self.event = event self.begintime = event.begin.datetime.astimezone()","ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the \"Termine\" Wiki","\"\"\" TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" width=\"100%\" style=\"border-collapse:collapse;\" ! style=\"width:250px;\"","= self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if","to the wiki archive page :param past_events: the past events that were not","begin_date(self): \"\"\" :return: Entropia-Wiki formatted begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\")","look at the sample config provided with the package\") raise error return ics_url,","'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config",":rtype: list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file","\"\"\" :return: The starting time of the event :rtype: str \"\"\" start_time =","WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was","- datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check if the event lies in","termine = BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings) + \"\\n\"","dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument(","= text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments from the command line,","ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events,","= text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\n' + year_header +","dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args","+ self.begin_date + self.end_date + \" || \" + self.start_time + \" ||","= \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\"","were not added to the events page :type past_events: list :param wiki_user: bot","+ self.location + \" || \" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw,","you write and everything you edit WILL BE OVERWRITTEN Dieser Text ist vom","= \"\" if self.endtime - self.begintime > timedelta(days=1): end_date = \" - \"","'|}': last_table_position = index if str(event) in text: continue if year_header in text:","\"--file\", dest=\"local_file\", help=\"Local ics file\", metavar=\"FILE\" ) parser.add_argument( \"--wiki-user\", dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\"","@property def start_time(self): \"\"\" :return: The starting time of the event :rtype: str","to an entropia-wiki suitable form \"\"\" def __init__(self, event): \"\"\" :param event: The","args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile)","\"--wiki-page\", dest=\"wiki_page\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' )","error return ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\" :param ics: input file","dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url","re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description","\" \" if self.event.location: location = self.event.location if location.lower() in locations.keys(): location =","in text: continue if year_header in text: append_list = ( '\\n' + LINE_SEPARATOR","parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False ) args = parser.parse_args() configfile = args.configfile","datetime import timedelta, datetime from ics import Calendar from mwclient import Site from","@property def end_date(self): \"\"\" :return: Entropia-Wiki formatted end time :rtype: str \"\"\" end_date","Read an ics file with the entropia events and insert them in to","file :rtype: list \"\"\" parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration","ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird","\" + self.location + \" || \" + self.description ) def append_past_events(past_events, wiki_user,","str :param wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None \"\"\"","= None event = self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki =","Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\" cellspacing=\"0\" cellpadding=\"5\" style=\"border-collapse:collapse;\"","configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki = { 'user':","if not self.event.all_day: start_time = self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\" :return:","formatted begin time :rtype: str \"\"\" return self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\"","for the wiki user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive:","a look at the sample config provided with the package\") raise error return","Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not","%d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki formatted end time :rtype: str \"\"\"","= get_args() event_strings = [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read()))","ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin):","ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR +","path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\", \"--url\", dest=\"ics_url\", help=\"The URL under which the ICS-file","debug = get_args() event_strings = [] past_events = [] if file: calendar =","|width=15%|'''Ort''' |width=69%|'''Beschreibung''' \"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit","+ ARCHIVE_TABLE_HEADER + '\\n' + LINE_SEPARATOR + '\\n' + str(event) + '\\n|}' )","self.begintime.strftime(\"%a., %d.%m.%Y\") @property def end_date(self): \"\"\" :return: Entropia-Wiki formatted end time :rtype: str","in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line return deradicalised def","wiki['pass'], wiki['archive']) termine = BOTWARNING + \"\\n\" + TABLE_HEADER + \"\\n\" + \"\".join(event_strings)",":rtype: bool \"\"\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \"\"\" :return: The","if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if","LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3","action=\"store_true\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file","[[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try:","{ 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug",":rtype: datetime.timedelta \"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check","added to the events page :type past_events: list :param wiki_user: bot user for","ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" ) parser.add_argument( \"-u\",","==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}': last_table_position = index","ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \"\\n\"+line return deradicalised def main():","\" + self.endtime.strftime(\"%a., %d.%m.%Y\") return end_date @property def days_to_event(self): \"\"\" :return: Days to","configparser.ConfigParser() config.read(configfile) try: ics_url = config[\"default\"][\"url\"] wiki = config[\"wiki\"] except KeyError as error:","site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0 for event in past_events: year_header =","= 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event","the ics2entropiawiki bot, everything you write and everything you edit WILL BE OVERWRITTEN","\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \"\"\" Append the \"new\"","\"\"\" end_date = \"\" if self.endtime - self.begintime > timedelta(days=1): end_date = \"","self.begintime.strftime(\"%H:%M\") return start_time @property def description(self): \"\"\" :return: The event's description :rtype: str","event in past_events: year_header = \"== {} ==\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text):","to the events page :type past_events: list :param wiki_user: bot user for the","return (\"| \" + self.begin_date + self.end_date + \" || \" + self.start_time",":return: Days to the start of the event :rtype: datetime.timedelta \"\"\" return self.endtime","description(self): \"\"\" :return: The event's description :rtype: str \"\"\" links = None wiki","\"\"\" :return: A wiki line describing the event :rtype: str \"\"\" return (\"|","end_date(self): \"\"\" :return: Entropia-Wiki formatted end time :rtype: str \"\"\" end_date = \"\"","wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\n') last_table_position = 0 for event in","+ '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def get_args(): \"\"\" Retrieve arguments","dest=\"wiki_user\", help=\"Wiki user\", metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" )","wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None \"\"\" site =","event to be evaluated :type event: ics.event.Event \"\"\" self.event = event self.begintime =","the sample config provided with the package\") raise error return ics_url, file, wiki,","None event = self.event if event.description: links = re.findall(\"^[Ll]ink:(.*)$\", event.description) wiki = re.findall(\"^[Ww]iki:(.*)$\",","wiki = re.findall(\"^[Ww]iki:(.*)$\", event.description) if links and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif","!! style=\"width:50px;\" | Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {|","description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0] elif not event.name: description","dest=\"ics_url\", help=\"The URL under which the ICS-file can be retrieved\", metavar=\"URL\", ) parser.add_argument(","\"\"\" :param event: The event to be evaluated :type event: ics.event.Event \"\"\" self.event","that were not added to the events page :type past_events: list :param wiki_user:",":type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return: None :rtype:","config[\"wiki\"] except KeyError as error: print(\"Please have a look at the sample config","\"\"\" TABLE_FOOTER = ( \"|}\", \"\\n\", \"Weitere Links: [[Vorlage:Termine|Termine]] \", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \"","event: The event to be evaluated :type event: ics.event.Event \"\"\" self.event = event","self.endtime - self.begintime > timedelta(days=1): end_date = \" - \" + self.endtime.strftime(\"%a., %d.%m.%Y\")","'archive': args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try:","# -*- coding: utf-8 -*- \"\"\"ics2entropiawiki Read an ics file with the entropia","Check if the event lies in the past :rtype: bool \"\"\" return self.days_to_event","\"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False )","text is automatically generated by the ics2entropiawiki bot, everything you write and everything","arguments from command line, config file :rtype: list \"\"\" parser = ArgumentParser() parser.add_argument(","\", \"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL,","parser = ArgumentParser() parser.add_argument( \"-c\", \"--config\", default=\"/etc/ics2entropiawiki/config.ini\", dest=\"configfile\", help=\"Configuration file path\", metavar=\"CONFIG\" )","== '|}': last_table_position = index if str(event) in text: continue if year_header in","\"\"\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \"\"\" :return: Check if the","parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\", dest=\"debug\", action=\"store_true\", default=False","page', metavar='WIKIPAGE' ) parser.add_argument( \"--wiki-archive\", dest=\"wiki_archive\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \"-d\", \"--debug\",","evaluated :type event: ics.event.Event \"\"\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime =","and event.name: description = \"[\"+links[0]+\" \"+event.name+\"]\" elif wiki: description = wiki[0] elif not","the wiki archive page :param past_events: the past events that were not added","Bearbeiten]),\", \" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except","password for the wiki user :type wiki_pw: str :param wiki_archive: archive page :type","metavar=\"WIKIUSER\" ) parser.add_argument( \"--wiki-password\", dest=\"wiki_pw\", help=\"Wiki user's password\", metavar=\"WIKIPW\" ) parser.add_argument( \"--wiki-page\", dest=\"wiki_page\",","| Zeit !! Ort !! Beschreibung\\ \"\"\" ARCHIVE_TABLE_HEADER = \"\"\" {| class=\"termine\" border=\"1\"","key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \"\\n\" + LINE_SEPARATOR","@property def description(self): \"\"\" :return: The event's description :rtype: str \"\"\" links =","'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \"\"\" Parses an ics Event and converts","elif wiki: description = wiki[0] elif not event.name: description = \"N.A.\" else: description","get_args() event_strings = [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else:","location of an event :return: location :rtype: str \"\"\" locations = { \"entropia\":","package\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \"\"\" :param ics:","+ '\\n' + str(event) + '\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\"\\n\".join(text)) def","line describing the event :rtype: str \"\"\" return (\"| \" + self.begin_date +","if txtline == '|}': last_table_position = index if str(event) in text: continue if","at the sample config provided with the package\") raise error return ics_url, file,","[[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\" ) LINE_SEPARATOR = \"|-\\n\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass"],"string":"[\n \"def location(self): \\\"\\\"\\\" Retrieve the location of an event :return: location :rtype: str\",\n \"describing the event :rtype: str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date + self.end_date\",\n \"= self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @property def\",\n \"the wiki user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str\",\n \"args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki =\",\n \"EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and converts it to an entropia-wiki suitable\",\n \"page :type past_events: list :param wiki_user: bot user for the wiki :type wiki_user:\",\n \"! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\"\",\n \"wiki archive page :param past_events: the past events that were not added to\",\n \"be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" )\",\n \"bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN -->\",\n \"| Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER =\",\n \"ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have a\",\n \"not in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return: None\",\n \"event.name: description = \\\"N.A.\\\" else: description = event.name return description def __str__(self): \\\"\\\"\\\"\",\n \"the location of an event :return: location :rtype: str \\\"\\\"\\\" locations = {\",\n \"ics_url, file, wiki, debug = get_args() event_strings = [] past_events = [] if\",\n \"datetime from ics import Calendar from mwclient import Site from dateutil.tz import tzlocal\",\n \"the start of the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property\",\n \"\\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\"\",\n \"= \\\"\\\"\\\" <!-- This text is automatically generated by the ics2entropiawiki bot, everything\",\n \"'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event =\",\n \"raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input\",\n \"= \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung'''\",\n \"appends past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser import\",\n \"args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile:\",\n \"locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype:\",\n \"help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which\",\n \"location(self): \\\"\\\"\\\" Retrieve the location of an event :return: location :rtype: str \\\"\\\"\\\"\",\n \"dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under\",\n \"\\\"\\\"\\\" import locale import configparser import re import requests from argparse import ArgumentParser\",\n \"in text: append_list = ( '\\\\n' + LINE_SEPARATOR + str(event) ) text =\",\n \"path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\") page.purge()\",\n \"#!/usr/bin/env python3 # -*- coding: utf-8 -*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with\",\n \"+ str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 *\",\n \"retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument(\",\n \":return: Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime\",\n \"--> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" !\",\n \"wiki_archive: str :return: None :rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw)\",\n \"from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text is automatically generated\",\n \"\\\"\\\"\\\" :return: The event's description :rtype: str \\\"\\\"\\\" links = None wiki =\",\n \"event.name return description def __str__(self): \\\"\\\"\\\" :return: A wiki line describing the event\",\n \"year_header in text: append_list = ( '\\\\n' + LINE_SEPARATOR + str(event) ) text\",\n \"= event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve\",\n \"pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and converts it to an\",\n \"args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config =\",\n \"$ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the \\\"Termine\\\"\",\n \"site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0 for event\",\n \"editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\"\",\n \") def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events to\",\n \"else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER\",\n \"+ self.end_date + \\\" || \\\" + self.start_time + \\\" || \\\" +\",\n \"Days to the start of the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime -\",\n \"list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\",\",\n \"[] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8'\",\n \"in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events\",\n \"class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER =\",\n \"__init__(self, event): \\\"\\\"\\\" :param event: The event to be evaluated :type event: ics.event.Event\",\n \"]+text[last_table_position:] else: append_list = ( 3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER +\",\n \"debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine:\",\n \"help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument(\",\n \"\\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line\",\n \":param wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None \\\"\\\"\\\" site\",\n \"not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'],\",\n \"metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\",\",\n \"'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser()\",\n \"description = event.name return description def __str__(self): \\\"\\\"\\\" :return: A wiki line describing\",\n \"\\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self):\",\n \"+ LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine =\",\n \"the wiki :type wiki_user: str :param wiki_pw: password for the wiki user :type\",\n \"def get_args(): \\\"\\\"\\\" Retrieve arguments from the command line, the config file respectively\",\n \"None :rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug = get_args() event_strings = []\",\n \"= BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" +\",\n \"append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\"\",\n \"help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument(\",\n \"if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events,\",\n \"get_args(): \\\"\\\"\\\" Retrieve arguments from the command line, the config file respectively :return:\",\n \"metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki\",\n \"The event's description :rtype: str \\\"\\\"\\\" links = None wiki = None event\",\n \"+ \\\" || \\\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\"\",\n \"LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses\",\n \"self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events\",\n \"+ self.start_time + \\\" || \\\" + self.location + \\\" || \\\" +\",\n \"Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\"\",\n \"|| \\\" + self.location + \\\" || \\\" + self.description ) def append_past_events(past_events,\",\n \"line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised\",\n \"\\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if self.event.location: location = self.event.location if\",\n \"wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\"\",\n \"links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description\",\n \") args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file\",\n \"input file :type ics: str :return: file with remove radicale_headers \\\"\\\"\\\" deradicalised =\",\n \"None :rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive]\",\n \"wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None\",\n \"locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and converts it to\",\n \"= self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\" :return: The event's description :rtype:\",\n \") parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\",\",\n \"parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\",\",\n \":rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug = get_args() event_strings = [] past_events\",\n \"@property def days_to_event(self): \\\"\\\"\\\" :return: Days to the start of the event :rtype:\",\n \"user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\",\",\n \"from command line, config file :rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\",\",\n \"sample config provided with the package\\\") raise error return ics_url, file, wiki, debug\",\n \"self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self):\",\n \"links = None wiki = None event = self.event if event.description: links =\",\n \"past events that were not added to the events page :type past_events: list\",\n \"debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type ics: str :return: file\",\n \"event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property\",\n \"page.text().split('\\\\n') last_table_position = 0 for event in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y'))\",\n \"everything you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch\",\n \"end_date = \\\"\\\" if self.endtime - self.begintime > timedelta(days=1): end_date = \\\" -\",\n \"|width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\",\",\n \"end time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime - self.begintime >\",\n \"\\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error:\",\n \"> timedelta(days=1): end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property\",\n \"!! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\"\",\n \"= re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki:\",\n \"not added to the events page :type past_events: list :param wiki_user: bot user\",\n \"event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the location of an\",\n \"an event :return: location :rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", }\",\n \"WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\"\",\n \"None \\\"\\\"\\\" ics_url, file, wiki, debug = get_args() event_strings = [] past_events =\",\n \"= re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description =\",\n \"Site from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text is automatically\",\n \"append_list = ( 3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n' +\",\n \"ics file with the entropia events and insert them in to the entropia\",\n \"TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site\",\n \"the \\\"new\\\" past events to the wiki archive page :param past_events: the past\",\n \"None wiki = None event = self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description)\",\n \"ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\",\",\n \"elif not event.name: description = \\\"N.A.\\\" else: description = event.name return description def\",\n \") parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile =\",\n \":rtype: str \\\"\\\"\\\" start_time = \\\" \\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\")\",\n \"ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type ics:\",\n \"border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = (\",\n \":param ics: input file :type ics: str :return: file with remove radicale_headers \\\"\\\"\\\"\",\n \"you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert.\",\n \"cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\",\",\n \"to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser import re import requests\",\n \"locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted\",\n \"the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in\",\n \":rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\"\",\n \":rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime - self.begintime > timedelta(days=1): end_date\",\n \"index, txtline in enumerate(text): if txtline == '|}': last_table_position = index if str(event)\",\n \"if year_header in text: append_list = ( '\\\\n' + LINE_SEPARATOR + str(event) )\",\n \"\\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\",\",\n \"BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER)\",\n \"\\\" + self.begin_date + self.end_date + \\\" || \\\" + self.start_time + \\\"\",\n \"= None wiki = None event = self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\",\",\n \"help=\\\"The URL under which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\",\",\n \"def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type ics: str :return: file with\",\n \"\\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']]\",\n \"ics import Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING =\",\n \"past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline\",\n \"args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, }\",\n \"self.start_time + \\\" || \\\" + self.location + \\\" || \\\" + self.description\",\n \") LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\"\",\n \"line, config file :rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\",\",\n \"Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime -\",\n \"under which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\",\",\n \"config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have a look at\",\n \"%d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days to the start of\",\n \":return: Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def\",\n \"= index if str(event) in text: continue if year_header in text: append_list =\",\n \"= parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki =\",\n \":param past_events: the past events that were not added to the events page\",\n \"+ self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past\",\n \"URL under which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\",\",\n \"ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN\",\n \"\\\"\\\"\\\"ics2entropiawiki Read an ics file with the entropia events and insert them in\",\n \"\\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug:\",\n \"archive page :type wiki_archive: str :return: None :rtype: None \\\"\\\"\\\" site = Site('entropia.de',\",\n \"append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events to the wiki\",\n \"error: print(\\\"Please have a look at the sample config provided with the package\\\")\",\n \"suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event: The event to be\",\n \"past_events: the past events that were not added to the events page :type\",\n \"= args.configfile ics_url = args.ics_url file = args.local_file wiki = { 'user': args.wiki_user,\",\n \"dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" )\",\n \"= event.name return description def __str__(self): \\\"\\\"\\\" :return: A wiki line describing the\",\n \"def main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug =\",\n \"it to an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event:\",\n \"to the \\\"Termine\\\" Wiki page and appends past events to the \\\"Vergangene_Termine\\\" Site\",\n \"time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime - self.begintime > timedelta(days=1):\",\n \"start_time(self): \\\"\\\"\\\" :return: The starting time of the event :rtype: str \\\"\\\"\\\" start_time\",\n \"def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a.,\",\n \"'\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list,\",\n \"with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:'\",\n \"last_table_position = 0 for event in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for\",\n \"wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events to the wiki archive page :param\",\n \"if 'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\"\",\n \"site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\") page.purge() if __name__ == '__main__': main()\",\n \"+ self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days to the\",\n \"= event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the location of\",\n \"parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki\",\n \"ics.event.Event \\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def\",\n \"wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events to the wiki archive page\",\n \"parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page',\",\n \"import configparser import re import requests from argparse import ArgumentParser from datetime import\",\n \"and converts it to an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\"\",\n \"datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check if the event lies in the\",\n \"+ \\\" || \\\" + self.location + \\\" || \\\" + self.description )\",\n \"the past events that were not added to the events page :type past_events:\",\n \"BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier\",\n \"\\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !!\",\n \"text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from the command line, the\",\n \"-*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with the entropia events and insert them\",\n \"events to the wiki archive page :param past_events: the past events that were\",\n \"import timedelta, datetime from ics import Calendar from mwclient import Site from dateutil.tz\",\n \"from argparse import ArgumentParser from datetime import timedelta, datetime from ics import Calendar\",\n \"in the past to the \\\"Termine\\\" Wiki page and appends past events to\",\n \"event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\"\",\n \"the event lies in the past :rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0)\",\n \"A wiki line describing the event :rtype: str \\\"\\\"\\\" return (\\\"| \\\" +\",\n \"archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args()\",\n \"import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text is automatically generated by the\",\n \"file :type ics: str :return: file with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\"\",\n \"end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days to the start of the event\",\n \"wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events to the wiki archive\",\n \"'\\\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list =\",\n \"BOTWARNING = \\\"\\\"\\\" <!-- This text is automatically generated by the ics2entropiawiki bot,\",\n \"self.location + \\\" || \\\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive):\",\n \"None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text =\",\n \"debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"]\",\n \"deradicalised += \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\"\",\n \"past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER +\",\n \"{ \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if self.event.location: location = self.event.location\",\n \"__str__(self): \\\"\\\"\\\" :return: A wiki line describing the event :rtype: str \\\"\\\"\\\" return\",\n \"= args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page':\",\n \"utf-8 -*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with the entropia events and insert\",\n \"for index, txtline in enumerate(text): if txtline == '|}': last_table_position = index if\",\n \"default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL\",\n \") text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from the\",\n \"the past :rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\"\",\n \"try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have\",\n \"from mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This\",\n \"location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\"\",\n \"can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\"\",\n \"radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in\",\n \"in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return: None :rtype:\",\n \":return: None :rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug = get_args() event_strings =\",\n \"event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive'])\",\n \"str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if\",\n \"except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and converts it\",\n \"+ \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site =\",\n \"enumerate(text): if txtline == '|}': last_table_position = index if str(event) in text: continue\",\n \"python3 # -*- coding: utf-8 -*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with the\",\n \"mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text\",\n \"= Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was\",\n \"start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\" :return: The event's description\",\n \"print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine,\",\n \"page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\") page.purge() if __name__ ==\",\n \"def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\" end_date =\",\n \"def start_time(self): \\\"\\\"\\\" :return: The starting time of the event :rtype: str \\\"\\\"\\\"\",\n \"The event to be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime\",\n \"timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The starting time of the event :rtype:\",\n \"event :rtype: str \\\"\\\"\\\" start_time = \\\" \\\" if not self.event.all_day: start_time =\",\n \"\\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif not event.name: description = \\\"N.A.\\\"\",\n \"self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links\",\n \"|width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\",\",\n \"respectively :return: Parsed arguments from command line, config file :rtype: list \\\"\\\"\\\" parser\",\n \"events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser import re import\",\n \"ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\",\",\n \"= configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as\",\n \"arguments from the command line, the config file respectively :return: Parsed arguments from\",\n \"'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if\",\n \"events that were not added to the events page :type past_events: list :param\",\n \"description def __str__(self): \\\"\\\"\\\" :return: A wiki line describing the event :rtype: str\",\n \"\\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'],\",\n \"metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile\",\n \"'\\\\n' + str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args():\",\n \":param event: The event to be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event =\",\n \"!! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\"\",\n \"\\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit'''\",\n \"days_to_event(self): \\\"\\\"\\\" :return: Days to the start of the event :rtype: datetime.timedelta \\\"\\\"\\\"\",\n \"]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from the command line, the config\",\n \"event.description) if links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description =\",\n \"wiki: description = wiki[0] elif not event.name: description = \\\"N.A.\\\" else: description =\",\n \"Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER =\",\n \"vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD\",\n \"and everything you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot\",\n \"help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\",\",\n \"insert them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini\",\n \"Append the \\\"new\\\" past events to the wiki archive page :param past_events: the\",\n \"--config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the \\\"Termine\\\" Wiki page\",\n \"= \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif not event.name: description =\",\n \"= page.text().split('\\\\n') last_table_position = 0 for event in past_events: year_header = \\\"== {}\",\n \":type ics: str :return: file with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for\",\n \"locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if self.event.location: location\",\n \"Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt\",\n \"site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\") page.purge() if\",\n \"def __str__(self): \\\"\\\"\\\" :return: A wiki line describing the event :rtype: str \\\"\\\"\\\"\",\n \"\\\" || \\\" + self.location + \\\" || \\\" + self.description ) def\",\n \"location :rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\"\",\n \"str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end\",\n \"time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki\",\n \"\\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\"\",\n \"command line, config file :rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\",\",\n \"\\\"\\\"\\\" return (\\\"| \\\" + self.begin_date + self.end_date + \\\" || \\\" +\",\n \"\\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE'\",\n \"of an event :return: location :rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\",\",\n \"\\\"N.A.\\\" else: description = event.name return description def __str__(self): \\\"\\\"\\\" :return: A wiki\",\n \"+ year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event) +\",\n \"\\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", )\",\n \":return: file with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line in ics.splitlines():\",\n \"self.event.location: location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location\",\n \"self.begintime > timedelta(days=1): end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date\",\n \"@property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\" return\",\n \"{| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER\",\n \"the event :rtype: str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date + self.end_date +\",\n \":type past_events: list :param wiki_user: bot user for the wiki :type wiki_user: str\",\n \"This text is automatically generated by the ics2entropiawiki bot, everything you write and\",\n \"the config file respectively :return: Parsed arguments from command line, config file :rtype:\",\n \"<!-- This text is automatically generated by the ics2entropiawiki bot, everything you write\",\n \":return: Check if the event lies in the past :rtype: bool \\\"\\\"\\\" return\",\n \"\\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" )\",\n \"event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the location of an event :return: location\",\n \"= \\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised +=\",\n \") else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" +\",\n \"else: description = event.name return description def __str__(self): \\\"\\\"\\\" :return: A wiki line\",\n \"past :rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return:\",\n \"config file :rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\",\",\n \"page :param past_events: the past events that were not added to the events\",\n \"\\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event: The event to be evaluated :type\",\n \"import re import requests from argparse import ArgumentParser from datetime import timedelta, datetime\",\n \"= { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if self.event.location: location =\",\n \"sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" +\",\n \"\\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR\",\n \"bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The starting\",\n \"\\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url, file,\",\n \"print(\\\"Please have a look at the sample config provided with the package\\\") raise\",\n \"ics: input file :type ics: str :return: file with remove radicale_headers \\\"\\\"\\\" deradicalised\",\n \"TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene\",\n \"hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {|\",\n \"user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\",\",\n \"text: append_list = ( '\\\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list,\",\n \":rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text\",\n \"file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\",\",\n \"the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics\",\n \"in enumerate(text): if txtline == '|}': last_table_position = index if str(event) in text:\",\n \"- \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days\",\n \":rtype: str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date + self.end_date + \\\" ||\",\n \"str(event) in text: continue if year_header in text: append_list = ( '\\\\n' +\",\n \"str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve\",\n \"year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline ==\",\n \"self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days to the start\",\n \"\\\"\\\"\\\" <!-- This text is automatically generated by the ics2entropiawiki bot, everything you\",\n \":return: Parsed arguments from command line, config file :rtype: list \\\"\\\"\\\" parser =\",\n \"else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in\",\n \"ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}' ) text\",\n \") parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki\",\n \":rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted\",\n \"\\\"\\\"\\\" :return: Check if the event lies in the past :rtype: bool \\\"\\\"\\\"\",\n \"EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event)\",\n \"path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0 for\",\n \"= [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result =\",\n \"remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not\",\n \"datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check if\",\n \"def is_past_event(self): \\\"\\\"\\\" :return: Check if the event lies in the past :rtype:\",\n \":param wiki_user: bot user for the wiki :type wiki_user: str :param wiki_pw: password\",\n \"if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and\",\n \"ics2entropiawiki bot, everything you write and everything you edit WILL BE OVERWRITTEN Dieser\",\n \"str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime - self.begintime > timedelta(days=1): end_date =\",\n \"list :param wiki_user: bot user for the wiki :type wiki_user: str :param wiki_pw:\",\n \"wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type ics: str :return:\",\n \"help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument(\",\n \"the events page :type past_events: list :param wiki_user: bot user for the wiki\",\n \"bot user for the wiki :type wiki_user: str :param wiki_pw: password for the\",\n \"txtline in enumerate(text): if txtline == '|}': last_table_position = index if str(event) in\",\n \"str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date + self.end_date + \\\" || \\\"\",\n \"= site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0 for event in past_events: year_header\",\n \"the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\"\",\n \"index if str(event) in text: continue if year_header in text: append_list = (\",\n \"if str(event) in text: continue if year_header in text: append_list = ( '\\\\n'\",\n \"file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the\",\n \"requests from argparse import ArgumentParser from datetime import timedelta, datetime from ics import\",\n \"str \\\"\\\"\\\" start_time = \\\" \\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return\",\n \"text: continue if year_header in text: append_list = ( '\\\\n' + LINE_SEPARATOR +\",\n \"everything you write and everything you edit WILL BE OVERWRITTEN Dieser Text ist\",\n \"converts it to an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param\",\n \"\\\"\\\" if self.endtime - self.begintime > timedelta(days=1): end_date = \\\" - \\\" +\",\n \"the package\\\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param\",\n \"\\\"\\\"\\\" :param ics: input file :type ics: str :return: file with remove radicale_headers\",\n \"wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug\",\n \"for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line return\",\n \"Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\")\",\n \"file with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line in ics.splitlines(): if\",\n \"an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event: The event\",\n \"- self.begintime > timedelta(days=1): end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return\",\n \"command line, the config file respectively :return: Parsed arguments from command line, config\",\n \"return self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The starting time of\",\n \") parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's\",\n \"wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\") page.purge() if __name__\",\n \") parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive',\",\n \"tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text is automatically generated by the ics2entropiawiki\",\n \"wiki :type wiki_user: str :param wiki_pw: password for the wiki user :type wiki_pw:\",\n \"Parsed arguments from command line, config file :rtype: list \\\"\\\"\\\" parser = ArgumentParser()\",\n \"wiki = config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have a look at the\",\n \"\\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if self.event.location: location = self.event.location if location.lower()\",\n \"with the entropia events and insert them in to the entropia homepage wiki.\",\n \"archive page :param past_events: the past events that were not added to the\",\n \"Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert,\",\n \"and appends past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser\",\n \"\\\"\\\"\\\" Retrieve arguments from the command line, the config file respectively :return: Parsed\",\n \"\\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The\",\n \"Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum'''\",\n \"the \\\"Termine\\\" Wiki page and appends past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\"\",\n \"write and everything you edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki\",\n \"ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\"\",\n \"parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE'\",\n \"= 0 for event in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index,\",\n \"the event :rtype: str \\\"\\\"\\\" start_time = \\\" \\\" if not self.event.all_day: start_time\",\n \"entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the\",\n \"args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki\",\n \"[] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url)\",\n \"ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort'''\",\n \"\\\"\\\"\\\" start_time = \\\" \\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time\",\n \"line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return: None :rtype: None\",\n \"( 3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR +\",\n \"|| \\\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the\",\n \"requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev:\",\n \"which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument( \\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local\",\n \"style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\"\",\n \"[[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent:\",\n \"description = \\\"N.A.\\\" else: description = event.name return description def __str__(self): \\\"\\\"\\\" :return:\",\n \"class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and converts it to an entropia-wiki\",\n \"page and appends past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import\",\n \"wiki_user: bot user for the wiki :type wiki_user: str :param wiki_pw: password for\",\n \"in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if\",\n \"\\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The starting time\",\n \"coding: utf-8 -*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with the entropia events and\",\n \"self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\" :return: The event's\",\n \"str :return: None :rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page\",\n \"event :return: location :rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location\",\n \"metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file can\",\n \"metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\",\",\n \"locale import configparser import re import requests from argparse import ArgumentParser from datetime\",\n \"generated by the ics2entropiawiki bot, everything you write and everything you edit WILL\",\n \"locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and\",\n \"wiki_user: str :param wiki_pw: password for the wiki user :type wiki_pw: str :param\",\n \") text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\\\n' +\",\n \"main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug = get_args()\",\n \"generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER\",\n \"-*- coding: utf-8 -*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with the entropia events\",\n \"< timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The starting time of the event\",\n \"ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event)\",\n \"= Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position =\",\n \"\\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time\",\n \"location = locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin\",\n \"+ LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = (\",\n \"= args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki\",\n \"if the event lies in the past :rtype: bool \\\"\\\"\\\" return self.days_to_event <\",\n \"= args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive,\",\n \"config provided with the package\\\") raise error return ics_url, file, wiki, debug def\",\n \":type event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone()\",\n \"\\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page\",\n \"Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0\",\n \"{| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\"\",\n \"Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class\",\n \"formatted end time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if self.endtime - self.begintime\",\n \"\\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n')\",\n \"the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser import re import requests from\",\n \"automatically generated by the ics2entropiawiki bot, everything you write and everything you edit\",\n \"\\\"Termine\\\" Wiki page and appends past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import\",\n \"\\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\" :return:\",\n \"events and insert them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py\",\n \"edit WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles\",\n \"str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\"\",\n \"entropia events and insert them in to the entropia homepage wiki. Example: $\",\n \"in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki\",\n \"site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position\",\n \"the command line, the config file respectively :return: Parsed arguments from command line,\",\n \"\\\" + self.start_time + \\\" || \\\" + self.location + \\\" || \\\"\",\n \"event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'],\",\n \"argparse import ArgumentParser from datetime import timedelta, datetime from ics import Calendar from\",\n \"by the ics2entropiawiki bot, everything you write and everything you edit WILL BE\",\n \"+ \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page =\",\n \"\\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\"\",\n \"from ics import Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING\",\n \"= { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug =\",\n \"deradicalised = \\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised\",\n \"= config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have a look at the sample\",\n \"self.end_date + \\\" || \\\" + self.start_time + \\\" || \\\" + self.location\",\n \"= Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if\",\n \"past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding\",\n \"text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\\\n' + year_header\",\n \"wiki user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return:\",\n \"import locale import configparser import re import requests from argparse import ArgumentParser from\",\n \"\\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\",\",\n \"def __init__(self, event): \\\"\\\"\\\" :param event: The event to be evaluated :type event:\",\n \"= EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else:\",\n \":return: A wiki line describing the event :rtype: str \\\"\\\"\\\" return (\\\"| \\\"\",\n \":param wiki_pw: password for the wiki user :type wiki_pw: str :param wiki_archive: archive\",\n \"start_time = \\\" \\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property\",\n \"= config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have a look\",\n \"Parses an ics Event and converts it to an entropia-wiki suitable form \\\"\\\"\\\"\",\n \"ics Event and converts it to an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self,\",\n \"for event in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in\",\n \"style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\\",\n \"site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot\",\n \"to the start of the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal())\",\n \"event :rtype: str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date + self.end_date + \\\"\",\n \"= \\\" \\\" if self.event.location: location = self.event.location if location.lower() in locations.keys(): location\",\n \"Inserts events not in the past to the \\\"Termine\\\" Wiki page and appends\",\n \"str :param wiki_pw: password for the wiki user :type wiki_pw: str :param wiki_archive:\",\n \"in the past :rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def start_time(self):\",\n \"links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif\",\n \"ArgumentParser from datetime import timedelta, datetime from ics import Calendar from mwclient import\",\n \"\\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property\",\n \"def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\" past events to the\",\n \"3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n'\",\n \"event's description :rtype: str \\\"\\\"\\\" links = None wiki = None event =\",\n \"text = page.text().split('\\\\n') last_table_position = 0 for event in past_events: year_header = \\\"==\",\n \"return deradicalised def main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url, file, wiki,\",\n \"config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError\",\n \"width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort !!\",\n \"manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\"\",\n \"\\\"\\\"\\\" ics_url, file, wiki, debug = get_args() event_strings = [] past_events = []\",\n \"wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) +\",\n \"self.begin_date + self.end_date + \\\" || \\\" + self.start_time + \\\" || \\\"\",\n \"\\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug = get_args() event_strings\",\n \"\\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser import re import requests from argparse\",\n \"width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links:\",\n \"args.configfile ics_url = args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass':\",\n \"str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\\\n'\",\n \"if self.event.location: location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return\",\n \"= requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda\",\n \"\\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\" if\",\n \"configparser import re import requests from argparse import ArgumentParser from datetime import timedelta,\",\n \"text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER\",\n \"default=False ) args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file =\",\n \"event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append(\",\n \"(\\\"| \\\" + self.begin_date + self.end_date + \\\" || \\\" + self.start_time +\",\n \"Wiki page and appends past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale\",\n \"events not in the past to the \\\"Termine\\\" Wiki page and appends past\",\n \"\\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics\",\n \"cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit !!\",\n \"event): \\\"\\\"\\\" :param event: The event to be evaluated :type event: ics.event.Event \\\"\\\"\\\"\",\n \") parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\",\",\n \"OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell\",\n \"import requests from argparse import ArgumentParser from datetime import timedelta, datetime from ics\",\n \"description = wiki[0] elif not event.name: description = \\\"N.A.\\\" else: description = event.name\",\n \"= [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding =\",\n \"if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar\",\n \"file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive':\",\n \"except KeyError as error: print(\\\"Please have a look at the sample config provided\",\n \"= site.pages[wiki['page']] if termine: page.save(termine, \\\"Terminbot was here\\\") page.purge() if __name__ == '__main__':\",\n \"calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event)\",\n \"args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page,\",\n \"wiki = None event = self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki\",\n \"dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text is automatically generated by\",\n \"configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except\",\n \"not in the past to the \\\"Termine\\\" Wiki page and appends past events\",\n \"timedelta, datetime from ics import Calendar from mwclient import Site from dateutil.tz import\",\n \"The starting time of the event :rtype: str \\\"\\\"\\\" start_time = \\\" \\\"\",\n \"try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event\",\n \"and insert them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config\",\n \"if links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0]\",\n \"args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url\",\n \"re import requests from argparse import ArgumentParser from datetime import timedelta, datetime from\",\n \"( '\\\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list\",\n \"\\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url =\",\n \"event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR + str(event) )\",\n \"self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check if the event lies\",\n \"wiki line describing the event :rtype: str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date\",\n \"is automatically generated by the ics2entropiawiki bot, everything you write and everything you\",\n \"Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\"\",\n \"return end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days to the start of the\",\n \"the entropia events and insert them in to the entropia homepage wiki. Example:\",\n \"page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from the command line, the config file\",\n \"* '\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n' +\",\n \"start_time @property def description(self): \\\"\\\"\\\" :return: The event's description :rtype: str \\\"\\\"\\\" links\",\n \"events page :type past_events: list :param wiki_user: bot user for the wiki :type\",\n \"= wiki[0] elif not event.name: description = \\\"N.A.\\\" else: description = event.name return\",\n \"str :return: file with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line in\",\n \"= ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]],\",\n \"= \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum\",\n \"+ str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\"\",\n \"to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not\",\n \"form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event: The event to be evaluated\",\n \"the past to the \\\"Termine\\\" Wiki page and appends past events to the\",\n \"0 for event in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline\",\n \"homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past\",\n \"self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The starting time of the\",\n \"def description(self): \\\"\\\"\\\" :return: The event's description :rtype: str \\\"\\\"\\\" links = None\",\n \"\\\"\\\"\\\" Retrieve the location of an event :return: location :rtype: str \\\"\\\"\\\" locations\",\n \"location = \\\" \\\" if self.event.location: location = self.event.location if location.lower() in locations.keys():\",\n \"from datetime import timedelta, datetime from ics import Calendar from mwclient import Site\",\n \"+ \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass'])\",\n \"ics: str :return: file with remove radicale_headers \\\"\\\"\\\" deradicalised = \\\"\\\" for line\",\n \"\\\"-f\\\", \\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\",\",\n \"from the command line, the config file respectively :return: Parsed arguments from command\",\n \"config file respectively :return: Parsed arguments from command line, config file :rtype: list\",\n \"= \\\" \\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def\",\n \"import Site from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!-- This text is\",\n \"= ( '\\\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else:\",\n \"in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\"\",\n \"\\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8')\",\n \"event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name:\",\n \"cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\",\",\n \"page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0 for event in past_events:\",\n \"\\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location = \\\" \\\" if self.event.location:\",\n \"'\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event)\",\n \"\\\" || \\\" + self.start_time + \\\" || \\\" + self.location + \\\"\",\n \"def days_to_event(self): \\\"\\\"\\\" :return: Days to the start of the event :rtype: datetime.timedelta\",\n \"= \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}':\",\n \"+= \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url,\",\n \"metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki\",\n \"= event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the location of an event :return:\",\n \"+ '\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}' ) text =\",\n \"bot, everything you write and everything you edit WILL BE OVERWRITTEN Dieser Text\",\n \"import ArgumentParser from datetime import timedelta, datetime from ics import Calendar from mwclient\",\n \"= Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for\",\n \") parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file can be\",\n \"+ LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:]\",\n \"wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to\",\n \"= \\\"N.A.\\\" else: description = event.name return description def __str__(self): \\\"\\\"\\\" :return: A\",\n \"start of the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def\",\n \"time of the event :rtype: str \\\"\\\"\\\" start_time = \\\" \\\" if not\",\n \"re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description = \\\"[\\\"+links[0]+\\\"\",\n \"str \\\"\\\"\\\" links = None wiki = None event = self.event if event.description:\",\n \"wiki, debug = get_args() event_strings = [] past_events = [] if file: calendar\",\n \"be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime\",\n \"user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return: None\",\n \"Site \\\"\\\"\\\" import locale import configparser import re import requests from argparse import\",\n \"timedelta(days=1): end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def\",\n \"Event and converts it to an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event):\",\n \"event_strings = [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result\",\n \"event = self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description)\",\n \"file, wiki, debug = get_args() event_strings = [] past_events = [] if file:\",\n \"style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER\",\n \"\\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}': last_table_position\",\n \"|| \\\" + self.start_time + \\\" || \\\" + self.location + \\\" ||\",\n \"with the package\\\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\"\",\n \"event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif not event.name:\",\n \"Retrieve arguments from the command line, the config file respectively :return: Parsed arguments\",\n \"provided with the package\\\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics):\",\n \":return: location :rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\": \\\"[[Anfahrt|Entropia]]\\\", } location =\",\n \"@property def location(self): \\\"\\\"\\\" Retrieve the location of an event :return: location :rtype:\",\n \"of the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self):\",\n \"is_past_event(self): \\\"\\\"\\\" :return: Check if the event lies in the past :rtype: bool\",\n \"event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return:\",\n \"\\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif not event.name: description = \\\"N.A.\\\" else:\",\n \"'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def main(): \\\"\\\"\\\" :return:\",\n \"LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING\",\n \"file: calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar =\",\n \"page :type wiki_archive: str :return: None :rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/')\",\n \"config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please\",\n \"location.lower() in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\" :return:\",\n \"for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event:\",\n \":return: None :rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user, wiki_pw) page =\",\n \"import Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\"\",\n \"hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\"\",\n \"\\\"\\\"\\\" Parses an ics Event and converts it to an entropia-wiki suitable form\",\n \"location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @property\",\n \"= ( 3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR\",\n \":type wiki_archive: str :return: None :rtype: None \\\"\\\"\\\" site = Site('entropia.de', path='/') site.login(wiki_user,\",\n \"\\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\"\",\n \"+ \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if\",\n \"event lies in the past :rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property\",\n \"\\\"\\\"\\\" Append the \\\"new\\\" past events to the wiki archive page :param past_events:\",\n \"\\\"new\\\" past events to the wiki archive page :param past_events: the past events\",\n \"begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return:\",\n \"Retrieve the location of an event :return: location :rtype: str \\\"\\\"\\\" locations =\",\n \"KeyError as error: print(\\\"Please have a look at the sample config provided with\",\n \"an ics Event and converts it to an entropia-wiki suitable form \\\"\\\"\\\" def\",\n \"Calendar from mwclient import Site from dateutil.tz import tzlocal BOTWARNING = \\\"\\\"\\\" <!--\",\n \"description :rtype: str \\\"\\\"\\\" links = None wiki = None event = self.event\",\n \"event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the\",\n \"file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type ics: str\",\n \"password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\",\",\n \"self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the location\",\n \"return start_time @property def description(self): \\\"\\\"\\\" :return: The event's description :rtype: str \\\"\\\"\\\"\",\n \"\\\"\\\\n\\\" + LINE_SEPARATOR + str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine\",\n \"an ics file with the entropia events and insert them in to the\",\n \"of the event :rtype: str \\\"\\\"\\\" start_time = \\\" \\\" if not self.event.all_day:\",\n \"LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text))\",\n \"wiki_pw: password for the wiki user :type wiki_pw: str :param wiki_archive: archive page\",\n \"last_table_position = index if str(event) in text: continue if year_header in text: append_list\",\n \"file with the entropia events and insert them in to the entropia homepage\",\n \"+ str(event) ) else: past_events.append(event) append_past_events(past_events, wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING +\",\n \"lies in the past :rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def\",\n \"cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit !! Ort\",\n \"past_events: list :param wiki_user: bot user for the wiki :type wiki_user: str :param\",\n \"if self.endtime - self.begintime > timedelta(days=1): end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a.,\",\n \"\\\" if self.event.location: location = self.event.location if location.lower() in locations.keys(): location = locations[location.lower()]\",\n \"past events to the \\\"Vergangene_Termine\\\" Site \\\"\\\"\\\" import locale import configparser import re\",\n \"+ \\\" || \\\" + self.start_time + \\\" || \\\" + self.location +\",\n \"wiki[0] elif not event.name: description = \\\"N.A.\\\" else: description = event.name return description\",\n \"for the wiki :type wiki_user: str :param wiki_pw: password for the wiki user\",\n \"'\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from\",\n \"file respectively :return: Parsed arguments from command line, config file :rtype: list \\\"\\\"\\\"\",\n \"as error: print(\\\"Please have a look at the sample config provided with the\",\n \"return ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type\",\n \"past events to the wiki archive page :param past_events: the past events that\",\n \"not event.name: description = \\\"N.A.\\\" else: description = event.name return description def __str__(self):\",\n \"continue if year_header in text: append_list = ( '\\\\n' + LINE_SEPARATOR + str(event)\",\n \"} debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url =\",\n \"= locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time\",\n \"not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\" :return: The\",\n \"append_list = ( '\\\\n' + LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:]\",\n \"Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event\",\n \"self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\"\",\n \"parser.parse_args() configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki = {\",\n \"return description def __str__(self): \\\"\\\"\\\" :return: A wiki line describing the event :rtype:\",\n \"Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the\",\n \"entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event: The event to\",\n \"automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\"\",\n \":type wiki_user: str :param wiki_pw: password for the wiki user :type wiki_pw: str\",\n \"them in to the entropia homepage wiki. Example: $ ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts\",\n \"\\\"\\\"\\\" :return: Days to the start of the event :rtype: datetime.timedelta \\\"\\\"\\\" return\",\n \"( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\"\",\n \"} location = \\\" \\\" if self.event.location: location = self.event.location if location.lower() in\",\n \"return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check if the event\",\n \"else: append_list = ( 3 * '\\\\n' + year_header + ARCHIVE_TABLE_HEADER + '\\\\n'\",\n \"\\\" \\\" if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self):\",\n \"TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" |\",\n \"\\\"\\\"\\\" deradicalised = \\\"\\\" for line in ics.splitlines(): if 'X-RADICALE-NAME:' not in line:\",\n \"\\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR =\",\n \"was hier manuell editiert, hinzugefügt wird WIRD ÜBERSCHRIEBEN --> \\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\"\",\n \"calendar = Calendar(deradicalise_ical(open(file).read())) else: ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text))\",\n \"/etc/ics2entropiawiki/config.ini Inserts events not in the past to the \\\"Termine\\\" Wiki page and\",\n \"Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self):\",\n \"\\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url\",\n \"\\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de',\",\n \"\\\" || \\\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append\",\n \"have a look at the sample config provided with the package\\\") raise error\",\n \"txtline == '|}': last_table_position = index if str(event) in text: continue if year_header\",\n \"line, the config file respectively :return: Parsed arguments from command line, config file\",\n \"style=\\\"border-collapse:collapse;\\\" width=\\\"100%\\\" |width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere\",\n \"starting time of the event :rtype: str \\\"\\\"\\\" start_time = \\\" \\\" if\",\n \"text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from the command\",\n \"= ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument(\",\n \"wiki['user'], wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" +\",\n \"+ TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine)\",\n \"if location.lower() in locations.keys(): location = locations[location.lower()] return location @property def begin_date(self): \\\"\\\"\\\"\",\n \":return: The event's description :rtype: str \\\"\\\"\\\" links = None wiki = None\",\n \"\\\"\\\"\\\" links = None wiki = None event = self.event if event.description: links\",\n \"Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\"\",\n \"parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\",\",\n \"+ \\\"\\\".join(event_strings) + \\\"\\\\n\\\" + \\\"\\\".join(TABLE_FOOTER) if debug: print(termine) site = Site('entropia.de', path='/')\",\n \"if configfile: config = configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"]\",\n \"deradicalised def main(): \\\"\\\"\\\" :return: None :rtype: None \\\"\\\"\\\" ics_url, file, wiki, debug\",\n \"self.endtime = event._end_time.datetime.astimezone() @property def location(self): \\\"\\\"\\\" Retrieve the location of an event\",\n \"@property def is_past_event(self): \\\"\\\"\\\" :return: Check if the event lies in the past\",\n \":rtype: str \\\"\\\"\\\" links = None wiki = None event = self.event if\",\n \"dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' )\",\n \"year_header + ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}'\",\n \"deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file :type ics: str :return: file with remove\",\n \":return: The starting time of the event :rtype: str \\\"\\\"\\\" start_time = \\\"\",\n \"class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" |\",\n \"end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self):\",\n \"|width=15%|'''Datum''' |width=6%|'''Zeit''' |width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]]\",\n \"past to the \\\"Termine\\\" Wiki page and appends past events to the \\\"Vergangene_Termine\\\"\",\n \"return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype:\",\n \"border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\" | Datum !! style=\\\"width:50px;\\\" | Zeit\",\n \"ics_url = args.ics_url file = args.local_file wiki = { 'user': args.wiki_user, 'pass': args.wiki_pw,\",\n \"user for the wiki :type wiki_user: str :param wiki_pw: password for the wiki\",\n \"parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file can be retrieved\\\",\",\n \"return location @property def begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype: str\",\n \"{} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}': last_table_position =\",\n \"help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args =\",\n \"= \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an\",\n \"to be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone()\",\n \"ics2entropiawiki.py --config /etc/ics2entropiawiki/config.ini Inserts events not in the past to the \\\"Termine\\\" Wiki\",\n \"\\\"\\\"\\\" TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" width=\\\"100%\\\" style=\\\"border-collapse:collapse;\\\" ! style=\\\"width:250px;\\\"\",\n \"= self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if\",\n \"to the wiki archive page :param past_events: the past events that were not\",\n \"begin_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\")\",\n \"look at the sample config provided with the package\\\") raise error return ics_url,\",\n \"'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config\",\n \":rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file\",\n \"\\\"\\\"\\\" :return: The starting time of the event :rtype: str \\\"\\\"\\\" start_time =\",\n \"WILL BE OVERWRITTEN Dieser Text ist vom ics2entropiawiki bot automatisch generiert. Alles was\",\n \"- datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check if the event lies in\",\n \"termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings) + \\\"\\\\n\\\"\",\n \"dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument(\",\n \"= text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments from the command line,\",\n \"ics_result = requests.get(ics_url) ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events,\",\n \"= text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3 * '\\\\n' + year_header +\",\n \"dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args\",\n \"+ self.begin_date + self.end_date + \\\" || \\\" + self.start_time + \\\" ||\",\n \"= \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\"\",\n \"were not added to the events page :type past_events: list :param wiki_user: bot\",\n \"+ self.location + \\\" || \\\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw,\",\n \"you write and everything you edit WILL BE OVERWRITTEN Dieser Text ist vom\",\n \"= \\\"\\\" if self.endtime - self.begintime > timedelta(days=1): end_date = \\\" - \\\"\",\n \"'|}': last_table_position = index if str(event) in text: continue if year_header in text:\",\n \"\\\"--file\\\", dest=\\\"local_file\\\", help=\\\"Local ics file\\\", metavar=\\\"FILE\\\" ) parser.add_argument( \\\"--wiki-user\\\", dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\"\",\n \"@property def start_time(self): \\\"\\\"\\\" :return: The starting time of the event :rtype: str\",\n \"to an entropia-wiki suitable form \\\"\\\"\\\" def __init__(self, event): \\\"\\\"\\\" :param event: The\",\n \"args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile)\",\n \"\\\"--wiki-page\\\", dest=\\\"wiki_page\\\", help='Wiki page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' )\",\n \"error return ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics: input file\",\n \"dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url\",\n \"re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description\",\n \"\\\" \\\" if self.event.location: location = self.event.location if location.lower() in locations.keys(): location =\",\n \"in text: continue if year_header in text: append_list = ( '\\\\n' + LINE_SEPARATOR\",\n \"parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile = args.configfile\",\n \"datetime import timedelta, datetime from ics import Calendar from mwclient import Site from\",\n \"@property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\" end_date\",\n \"Read an ics file with the entropia events and insert them in to\",\n \"file :rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration\",\n \"ist vom ics2entropiawiki bot automatisch generiert. Alles was hier manuell editiert, hinzugefügt wird\",\n \"\\\" + self.location + \\\" || \\\" + self.description ) def append_past_events(past_events, wiki_user,\",\n \"str :param wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None \\\"\\\"\\\"\",\n \"= None event = self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki =\",\n \"Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\" cellspacing=\\\"0\\\" cellpadding=\\\"5\\\" style=\\\"border-collapse:collapse;\\\"\",\n \"configfile = args.configfile ics_url = args.ics_url file = args.local_file wiki = { 'user':\",\n \"if not self.event.all_day: start_time = self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\" :return:\",\n \"formatted begin time :rtype: str \\\"\\\"\\\" return self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\"\",\n \"for the wiki user :type wiki_pw: str :param wiki_archive: archive page :type wiki_archive:\",\n \"a look at the sample config provided with the package\\\") raise error return\",\n \"Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event = EntropiaEvent(event) if not\",\n \"%d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\"\",\n \"= get_args() event_strings = [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read()))\",\n \"ics_result.encoding = 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin):\",\n \"ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR +\",\n \"path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\", \\\"--url\\\", dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file\",\n \"debug = get_args() event_strings = [] past_events = [] if file: calendar =\",\n \"|width=15%|'''Ort''' |width=69%|'''Beschreibung''' \\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit\",\n \"+ ARCHIVE_TABLE_HEADER + '\\\\n' + LINE_SEPARATOR + '\\\\n' + str(event) + '\\\\n|}' )\",\n \"self.begintime.strftime(\\\"%a., %d.%m.%Y\\\") @property def end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype: str\",\n \"in ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def\",\n \"wiki['pass'], wiki['archive']) termine = BOTWARNING + \\\"\\\\n\\\" + TABLE_HEADER + \\\"\\\\n\\\" + \\\"\\\".join(event_strings)\",\n \":rtype: bool \\\"\\\"\\\" return self.days_to_event < timedelta(days=0) @property def start_time(self): \\\"\\\"\\\" :return: The\",\n \"if debug: print(termine) site = Site('entropia.de', path='/') site.login(wiki['user'], wiki['pass']) page = site.pages[wiki['page']] if\",\n \"LINE_SEPARATOR + str(event) ) text = text[:last_table_position]+[append_list, ]+text[last_table_position:] else: append_list = ( 3\",\n \"action=\\\"store_true\\\", default=False ) args = parser.parse_args() configfile = args.configfile ics_url = args.ics_url file\",\n \"[[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try:\",\n \"{ 'user': args.wiki_user, 'pass': args.wiki_pw, 'page': args.wiki_page, 'archive': args.wiki_archive, } debug = args.debug\",\n \":rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check\",\n \"added to the events page :type past_events: list :param wiki_user: bot user for\",\n \"ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" ) parser.add_argument( \\\"-u\\\",\",\n \"==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text): if txtline == '|}': last_table_position = index\",\n \"ics.splitlines(): if 'X-RADICALE-NAME:' not in line: deradicalised += \\\"\\\\n\\\"+line return deradicalised def main():\",\n \"\\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\") return end_date @property def days_to_event(self): \\\"\\\"\\\" :return: Days to\",\n \"configparser.ConfigParser() config.read(configfile) try: ics_url = config[\\\"default\\\"][\\\"url\\\"] wiki = config[\\\"wiki\\\"] except KeyError as error:\",\n \"site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0 for event in past_events: year_header =\",\n \"= 'utf-8' calendar = Calendar(deradicalise_ical(ics_result.text)) for event in sorted(calendar.events, key=lambda ev: ev.begin): event\",\n \"the ics2entropiawiki bot, everything you write and everything you edit WILL BE OVERWRITTEN\",\n \"\\\" + self.description ) def append_past_events(past_events, wiki_user, wiki_pw, wiki_archive): \\\"\\\"\\\" Append the \\\"new\\\"\",\n \"\\\"\\\"\\\" end_date = \\\"\\\" if self.endtime - self.begintime > timedelta(days=1): end_date = \\\"\",\n \"self.begintime.strftime(\\\"%H:%M\\\") return start_time @property def description(self): \\\"\\\"\\\" :return: The event's description :rtype: str\",\n \"event in past_events: year_header = \\\"== {} ==\\\".format(event.endtime.strftime('%Y')) for index, txtline in enumerate(text):\",\n \"to the events page :type past_events: list :param wiki_user: bot user for the\",\n \"return (\\\"| \\\" + self.begin_date + self.end_date + \\\" || \\\" + self.start_time\",\n \":return: Days to the start of the event :rtype: datetime.timedelta \\\"\\\"\\\" return self.endtime\",\n \"description(self): \\\"\\\"\\\" :return: The event's description :rtype: str \\\"\\\"\\\" links = None wiki\",\n \"\\\"\\\"\\\" :return: A wiki line describing the event :rtype: str \\\"\\\"\\\" return (\\\"|\",\n \"end_date(self): \\\"\\\"\\\" :return: Entropia-Wiki formatted end time :rtype: str \\\"\\\"\\\" end_date = \\\"\\\"\",\n \"wiki_pw) page = site.pages[wiki_archive] text = page.text().split('\\\\n') last_table_position = 0 for event in\",\n \"+ '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def get_args(): \\\"\\\"\\\" Retrieve arguments\",\n \"dest=\\\"wiki_user\\\", help=\\\"Wiki user\\\", metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" )\",\n \"wiki_archive: archive page :type wiki_archive: str :return: None :rtype: None \\\"\\\"\\\" site =\",\n \"event to be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime =\",\n \"the sample config provided with the package\\\") raise error return ics_url, file, wiki,\",\n \"None event = self.event if event.description: links = re.findall(\\\"^[Ll]ink:(.*)$\\\", event.description) wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\",\",\n \"wiki = re.findall(\\\"^[Ww]iki:(.*)$\\\", event.description) if links and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif\",\n \"!! style=\\\"width:50px;\\\" | Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {|\",\n \"description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif not event.name: description\",\n \"dest=\\\"ics_url\\\", help=\\\"The URL under which the ICS-file can be retrieved\\\", metavar=\\\"URL\\\", ) parser.add_argument(\",\n \"\\\"\\\"\\\" :param event: The event to be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event\",\n \"that were not added to the events page :type past_events: list :param wiki_user:\",\n \":type wiki_pw: str :param wiki_archive: archive page :type wiki_archive: str :return: None :rtype:\",\n \"config[\\\"wiki\\\"] except KeyError as error: print(\\\"Please have a look at the sample config\",\n \"\\\"\\\"\\\" TABLE_FOOTER = ( \\\"|}\\\", \\\"\\\\n\\\", \\\"Weitere Links: [[Vorlage:Termine|Termine]] \\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\"\",\n \"event: The event to be evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event = event\",\n \"self.endtime - self.begintime > timedelta(days=1): end_date = \\\" - \\\" + self.endtime.strftime(\\\"%a., %d.%m.%Y\\\")\",\n \"'archive': args.wiki_archive, } debug = args.debug if configfile: config = configparser.ConfigParser() config.read(configfile) try:\",\n \"# -*- coding: utf-8 -*- \\\"\\\"\\\"ics2entropiawiki Read an ics file with the entropia\",\n \"Check if the event lies in the past :rtype: bool \\\"\\\"\\\" return self.days_to_event\",\n \"\\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False )\",\n \"text is automatically generated by the ics2entropiawiki bot, everything you write and everything\",\n \"arguments from command line, config file :rtype: list \\\"\\\"\\\" parser = ArgumentParser() parser.add_argument(\",\n \"\\\", \\\"([https://entropia.de/index.php?title=Vorlage:Termine&action=edit Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL,\",\n \"parser = ArgumentParser() parser.add_argument( \\\"-c\\\", \\\"--config\\\", default=\\\"/etc/ics2entropiawiki/config.ini\\\", dest=\\\"configfile\\\", help=\\\"Configuration file path\\\", metavar=\\\"CONFIG\\\" )\",\n \"== '|}': last_table_position = index if str(event) in text: continue if year_header in\",\n \"\\\"\\\"\\\" return self.endtime - datetime.now(tz=tzlocal()) @property def is_past_event(self): \\\"\\\"\\\" :return: Check if the\",\n \"parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\", dest=\\\"debug\\\", action=\\\"store_true\\\", default=False\",\n \"page', metavar='WIKIPAGE' ) parser.add_argument( \\\"--wiki-archive\\\", dest=\\\"wiki_archive\\\", help='Wiki archive', metavar='WIKIARCHIVE' ) parser.add_argument( \\\"-d\\\", \\\"--debug\\\",\",\n \"evaluated :type event: ics.event.Event \\\"\\\"\\\" self.event = event self.begintime = event.begin.datetime.astimezone() self.endtime =\",\n \"and event.name: description = \\\"[\\\"+links[0]+\\\" \\\"+event.name+\\\"]\\\" elif wiki: description = wiki[0] elif not\",\n \"the wiki archive page :param past_events: the past events that were not added\",\n \"Bearbeiten]),\\\", \\\" [[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except\",\n \"password for the wiki user :type wiki_pw: str :param wiki_archive: archive page :type\",\n \"metavar=\\\"WIKIUSER\\\" ) parser.add_argument( \\\"--wiki-password\\\", dest=\\\"wiki_pw\\\", help=\\\"Wiki user's password\\\", metavar=\\\"WIKIPW\\\" ) parser.add_argument( \\\"--wiki-page\\\", dest=\\\"wiki_page\\\",\",\n \"| Zeit !! Ort !! Beschreibung\\\\ \\\"\\\"\\\" ARCHIVE_TABLE_HEADER = \\\"\\\"\\\" {| class=\\\"termine\\\" border=\\\"1\\\"\",\n \"key=lambda ev: ev.begin): event = EntropiaEvent(event) if not event.is_past_event: event_strings.append( \\\"\\\\n\\\" + LINE_SEPARATOR\",\n \"@property def description(self): \\\"\\\"\\\" :return: The event's description :rtype: str \\\"\\\"\\\" links =\",\n \"'de_DE.utf8') except locale.Error: pass class EntropiaEvent: \\\"\\\"\\\" Parses an ics Event and converts\",\n \"elif wiki: description = wiki[0] elif not event.name: description = \\\"N.A.\\\" else: description\",\n \"get_args() event_strings = [] past_events = [] if file: calendar = Calendar(deradicalise_ical(open(file).read())) else:\",\n \"location of an event :return: location :rtype: str \\\"\\\"\\\" locations = { \\\"entropia\\\":\",\n \"package\\\") raise error return ics_url, file, wiki, debug def deradicalise_ical(ics): \\\"\\\"\\\" :param ics:\",\n \"+ '\\\\n' + str(event) + '\\\\n|}' ) text = text[:last_table_position+1]+[append_list, ]+text[last_table_position+1:] page.save(\\\"\\\\n\\\".join(text)) def\",\n \"line describing the event :rtype: str \\\"\\\"\\\" return (\\\"| \\\" + self.begin_date +\",\n \"if txtline == '|}': last_table_position = index if str(event) in text: continue if\",\n \"at the sample config provided with the package\\\") raise error return ics_url, file,\",\n \"[[Vorlage:Vergangene_Termine|Vergangene Termine]], [[Anfahrt]]\\\" ) LINE_SEPARATOR = \\\"|-\\\\n\\\" try: locale.setlocale(locale.LC_ALL, 'de_DE.utf8') except locale.Error: pass\"\n]","isConversational":false}}},{"rowIdx":286,"cells":{"ngram":{"kind":"list like","value":["os import random import re import sys # Complete the rotLeft function below.","rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__ ==","= list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr =","= int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d)","import re import sys # Complete the rotLeft function below. def rotLeft(a, d):","int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write('","= input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result","math import os import random import re import sys # Complete the rotLeft","= int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str, result)))","import sys # Complete the rotLeft function below. def rotLeft(a, d): alist =","alist = list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr","d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__':","rotLeft function below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return","if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n =","import math import os import random import re import sys # Complete the","def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__","__name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0])","list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'],","'__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d =","= open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d = int(nd[1]) a","int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str, result))) fptr.write('\\n')","Complete the rotLeft function below. def rotLeft(a, d): alist = list(a) b =","b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n","alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd =","below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if","import os import random import re import sys # Complete the rotLeft function","#!/bin/python3 import math import os import random import re import sys # Complete","= alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd","re import sys # Complete the rotLeft function below. def rotLeft(a, d): alist","sys # Complete the rotLeft function below. def rotLeft(a, d): alist = list(a)","import random import re import sys # Complete the rotLeft function below. def","# Complete the rotLeft function below. def rotLeft(a, d): alist = list(a) b","nd = input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split()))","input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result =","a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str, result))) fptr.write('\\n') fptr.close()","random import re import sys # Complete the rotLeft function below. def rotLeft(a,","the rotLeft function below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d]","fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d = int(nd[1])","open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d = int(nd[1]) a =","== '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d","return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split()","d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str,","'w') nd = input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int,","function below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b","b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w')","n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a,"],"string":"[\n \"os import random import re import sys # Complete the rotLeft function below.\",\n \"rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__ ==\",\n \"= list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr =\",\n \"= int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d)\",\n \"import re import sys # Complete the rotLeft function below. def rotLeft(a, d):\",\n \"int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write('\",\n \"= input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result\",\n \"math import os import random import re import sys # Complete the rotLeft\",\n \"= int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str, result)))\",\n \"import sys # Complete the rotLeft function below. def rotLeft(a, d): alist =\",\n \"alist = list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr\",\n \"d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__':\",\n \"rotLeft function below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return\",\n \"if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n =\",\n \"import math import os import random import re import sys # Complete the\",\n \"def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__\",\n \"__name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0])\",\n \"list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'],\",\n \"'__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d =\",\n \"= open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d = int(nd[1]) a\",\n \"int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str, result))) fptr.write('\\\\n')\",\n \"Complete the rotLeft function below. def rotLeft(a, d): alist = list(a) b =\",\n \"b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n\",\n \"alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd =\",\n \"below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if\",\n \"import os import random import re import sys # Complete the rotLeft function\",\n \"#!/bin/python3 import math import os import random import re import sys # Complete\",\n \"= alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd\",\n \"re import sys # Complete the rotLeft function below. def rotLeft(a, d): alist\",\n \"sys # Complete the rotLeft function below. def rotLeft(a, d): alist = list(a)\",\n \"import random import re import sys # Complete the rotLeft function below. def\",\n \"# Complete the rotLeft function below. def rotLeft(a, d): alist = list(a) b\",\n \"nd = input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split()))\",\n \"input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result =\",\n \"a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str, result))) fptr.write('\\\\n') fptr.close()\",\n \"random import re import sys # Complete the rotLeft function below. def rotLeft(a,\",\n \"the rotLeft function below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d]\",\n \"fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d = int(nd[1])\",\n \"open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d = int(nd[1]) a =\",\n \"== '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split() n = int(nd[0]) d\",\n \"return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w') nd = input().split()\",\n \"d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a, d) fptr.write(' '.join(map(str,\",\n \"'w') nd = input().split() n = int(nd[0]) d = int(nd[1]) a = list(map(int,\",\n \"function below. def rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b\",\n \"b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr = open(os.environ['OUTPUT_PATH'], 'w')\",\n \"n = int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().split())) result = rotLeft(a,\"\n]","isConversational":false}}},{"rowIdx":287,"cells":{"ngram":{"kind":"list like","value":["import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0","TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items():","= \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y =","num_jobs = 0 if platform.system() == \"Linux\" else 2 logging_folder = \"__test_zoo__\" class","= 0 if platform.system() == \"Linux\" else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase):","cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if","platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() ==","config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def","y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) ->","logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y","cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \"Linux\" else 2 logging_folder","str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo =","y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\"tree_dnn\")","-> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model)","key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder)","local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) ->","TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder =","TabularDataset num_jobs = 0 if platform.system() == \"Linux\" else 2 logging_folder = \"__test_zoo__\"","0 if platform.system() == \"Linux\" else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod","== \"Linux\" else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str)","@staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder,","import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \"Linux\"","None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for","= os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder =","= cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\")","pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\"tree_dnn\") if","= os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y,","cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder","= TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in","zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder","x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key,","for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m","= local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self)","class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder","os import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs =","local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x,","cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def","def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\"tree_dnn\") if __name__ ==","-> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\"tree_dnn\") if __name__ == \"__main__\": unittest.main()","import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system()","key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m =","zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"]","cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None:","else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None:","\"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy","def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\")","\"Linux\" else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) ->","f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key)","import TabularDataset num_jobs = 0 if platform.system() == \"Linux\" else 2 logging_folder =","y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config","unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \"Linux\" else","config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model,","os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m)","_test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo","cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\"tree_dnn\") if __name__","2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x,","in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x,","test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\"tree_dnn\") if __name__ == \"__main__\":","zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y)","import os import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs","= cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\"logging_folder\"] =","m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None:","from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \"Linux\" else 2","os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder,","**config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\"fcnn\") def test_tree_dnn_zoo(self)","if platform.system() == \"Linux\" else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def","platform.system() == \"Linux\" else 2 logging_folder = \"__test_zoo__\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model:"],"string":"[\n \"import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0\",\n \"TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items():\",\n \"= \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y =\",\n \"num_jobs = 0 if platform.system() == \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class\",\n \"= 0 if platform.system() == \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase):\",\n \"cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if\",\n \"platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() ==\",\n \"config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def\",\n \"y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) ->\",\n \"logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y\",\n \"cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \\\"Linux\\\" else 2 logging_folder\",\n \"str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo =\",\n \"y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\\\"tree_dnn\\\")\",\n \"-> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model)\",\n \"key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder)\",\n \"local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) ->\",\n \"TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder =\",\n \"TabularDataset num_jobs = 0 if platform.system() == \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\"\",\n \"0 if platform.system() == \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod\",\n \"== \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str)\",\n \"@staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder,\",\n \"import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \\\"Linux\\\"\",\n \"None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for\",\n \"= os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder =\",\n \"= cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\")\",\n \"pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\\\"tree_dnn\\\") if\",\n \"= os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y,\",\n \"cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder\",\n \"= TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config in\",\n \"zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder\",\n \"x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key,\",\n \"for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m\",\n \"= local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self)\",\n \"class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder\",\n \"os import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs =\",\n \"local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x,\",\n \"cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def\",\n \"def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\\\"tree_dnn\\\") if __name__ ==\",\n \"-> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\\\"tree_dnn\\\") if __name__ == \\\"__main__\\\": unittest.main()\",\n \"import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system()\",\n \"key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m =\",\n \"zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"]\",\n \"cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None:\",\n \"else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None:\",\n \"\\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy\",\n \"def _test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\")\",\n \"\\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) ->\",\n \"f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key)\",\n \"import TabularDataset num_jobs = 0 if platform.system() == \\\"Linux\\\" else 2 logging_folder =\",\n \"y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config\",\n \"unittest from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \\\"Linux\\\" else\",\n \"config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model,\",\n \"os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m)\",\n \"_test_zoo_core(model: str) -> None: x, y = TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\\\"__{model}__\\\") zoo\",\n \"cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\\\"tree_dnn\\\") if __name__\",\n \"2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model: str) -> None: x,\",\n \"in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x,\",\n \"test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self) -> None: self._test_zoo_core(\\\"tree_dnn\\\") if __name__ == \\\"__main__\\\":\",\n \"zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] = local_logging_folder m = cflearn.make(model, **config).fit(x, y)\",\n \"import os import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs\",\n \"= cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder, key) config[\\\"logging_folder\\\"] =\",\n \"m = cflearn.make(model, **config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None:\",\n \"from cfdata.tabular import TabularDataset num_jobs = 0 if platform.system() == \\\"Linux\\\" else 2\",\n \"os.path.join(logging_folder, f\\\"__{model}__\\\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items(): local_logging_folder = os.path.join(zoo_folder,\",\n \"**config).fit(x, y) cflearn.evaluate(x, y, pipelines=m) cflearn._rmtree(logging_folder) def test_fcnn_zoo(self) -> None: self._test_zoo_core(\\\"fcnn\\\") def test_tree_dnn_zoo(self)\",\n \"if platform.system() == \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def\",\n \"platform.system() == \\\"Linux\\\" else 2 logging_folder = \\\"__test_zoo__\\\" class TestZoo(unittest.TestCase): @staticmethod def _test_zoo_core(model:\"\n]","isConversational":false}}},{"rowIdx":288,"cells":{"ngram":{"kind":"list like","value":["the unsorted list at the midpoint into sublists. Takes O(k log n) quasilinear","the linked list into sublists containing a single node - Repeatedly merge the","right_head.next_node # Move current to next node current = current.next_node # Discard fake","set loop condition to False right_head = right_head.next_node # If the head node","is greater than right, set current to right node else: current.next_node = right_head","left_head is None: current.next_node = right_head # Call next on right to set","from right to merged linkned list if left_head is None: current.next_node = right_head","to set loop condition to False left_head = left_head.next_node else: # Not at","if left_data < right_data: current.next_node = left_head # Move left head to next","All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): '''","linked list that contains nodes from # merging left and right merged =","Not at either tail node # Obtain node data to perform comparison operations","merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted list at the","the sublists to produce sorted swublists until one remains Returns a sorted linked","lists left_head = left.head right_head = right.head # Iterate over left and right","past the tail # Add the tail node from left to merged linked","return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half)","merge_sort(linked_list): ''' Sorts a linked list in ascending order. - Recuresively divide the","right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def","midpoint into sublists. Takes O(k log n) quasilinear time. ''' if linked_list ==","head of the linked list current = merged.head # Obtain head nodes for","# If the head node of the left is None, we're past the","= merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted list at","= linked_list right_half = None return left_half, right_half else: # non-empty linked lists","at either tail node # Obtain node data to perform comparison operations left_data","merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list = merge_sort(l)","left_head.next_node # If data on left is greater than right, set current to","data on left is less than right, set current to left node if","non-empty linked lists size = linked_list.size() midpoint = size // 2 mid_node =","left.head right_head = right.head # Iterate over left and right until we reach","O(kn log n) time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty():","= mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right): ''' Merges","None, we're past the tail # Add the tail node from left to","right_head = right_head.next_node # Move current to next node current = current.next_node #","# Python Techdegree # # Created by <NAME> on 3/24/19. # Copyright (c)","the head node of right is None, we're past the tail # Add","a sorted linked list. Runs in O(kn log n) time. ''' if linked_list.size()","- Repeatedly merge the sublists to produce sorted swublists until one remains Returns","from # merging left and right merged = LinkedList() # Add a fake","fake head that is discarded later to simplify code merged.add(0) # Set current","first merged node as head head = merged.head.next_node merged.head = head return merged","a linked list in ascending order. - Recuresively divide the linked list into","merged = LinkedList() # Add a fake head that is discarded later to","= left_head.data right_data = right_head.data # If data on left is less than","mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node","tail # Add the node from right to merged linkned list if left_head","to next node right_head = right_head.next_node # Move current to next node current","None: left_half = linked_list right_half = None return left_half, right_half else: # non-empty","= merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the","in ascending order. - Recuresively divide the linked list into sublists containing a","of either while left_head or right_head: # If the head node of the","right_head # Move right head to next node right_head = right_head.next_node # Move","<gh_stars>10-100 # # Data Structures: Linked List Merge Sort: The Conquer Step #","than right, set current to left node if left_data < right_data: current.next_node =","linked list. Runs in O(kn log n) time. ''' if linked_list.size() == 1:","than right, set current to right node else: current.next_node = right_head # Move","# Move right head to next node right_head = right_head.next_node # Move current","linked_list right_half = None return left_half, right_half else: # non-empty linked lists size","left head to next node left_head = left_head.next_node # If data on left","lists size = linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half","# Call next on right to set loop condition to False right_head =","right_half = None return left_half, right_half else: # non-empty linked lists size =","list if left_head is None: current.next_node = right_head # Call next on right","and set first merged node as head head = merged.head.next_node merged.head = head","linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left,","time. ''' # Create a new linked list that contains nodes from #","LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending order. - Recuresively","to simplify code merged.add(0) # Set current to the head of the linked","Techdegree # # Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps.","node # Obtain node data to perform comparison operations left_data = left_head.data right_data","head and set first merged node as head head = merged.head.next_node merged.head =","merge(left, right): ''' Merges two linked lists, sorting by data in nodes. Returns","None: current.next_node = right_head # Call next on right to set loop condition","= head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l)","# merging left and right merged = LinkedList() # Add a fake head","swublists until one remains Returns a sorted linked list. Runs in O(kn log","node from left to merged linked list elif right_head is None: current.next_node =","// 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half =","discarded later to simplify code merged.add(0) # Set current to the head of","right_head # Call next on right to set loop condition to False right_head","linked lists size = linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1)","linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending","= left_head # Call next on left to set loop condition to False","Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved.","mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right): ''' Merges two","# Create a new linked list that contains nodes from # merging left","< right_data: current.next_node = left_head # Move left head to next node left_head","None return left_half, right_half def merge(left, right): ''' Merges two linked lists, sorting","linked list elif right_head is None: current.next_node = left_head # Call next on","the tail node # of either while left_head or right_head: # If the","right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted list","= right.head # Iterate over left and right until we reach the tail","right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right): '''","left_data < right_data: current.next_node = left_head # Move left head to next node","- Recuresively divide the linked list into sublists containing a single node -","nodes from # merging left and right merged = LinkedList() # Add a","current to the head of the linked list current = merged.head # Obtain","list that contains nodes from # merging left and right merged = LinkedList()","Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node,","to next node current = current.next_node # Discard fake head and set first","into sublists containing a single node - Repeatedly merge the sublists to produce","is less than right, set current to left node if left_data < right_data:","return left_half, right_half def merge(left, right): ''' Merges two linked lists, sorting by","set current to left node if left_data < right_data: current.next_node = left_head #","current = current.next_node # Discard fake head and set first merged node as","that is discarded later to simplify code merged.add(0) # Set current to the","and right linked lists left_head = left.head right_head = right.head # Iterate over","to right node else: current.next_node = right_head # Move right head to next","set current to right node else: current.next_node = right_head # Move right head","''' if linked_list == None or linked_list.head == None: left_half = linked_list right_half","else: current.next_node = right_head # Move right head to next node right_head =","current.next_node = left_head # Move left head to next node left_head = left_head.next_node","data to perform comparison operations left_data = left_head.data right_data = right_head.data # If","merge(left, right) def split(linked_list): ''' Divide the unsorted list at the midpoint into","# Call next on left to set loop condition to False left_head =","right.head # Iterate over left and right until we reach the tail node","left to set loop condition to False left_head = left_head.next_node else: # Not","# If data on left is less than right, set current to left","== None: left_half = linked_list right_half = None return left_half, right_half else: #","= merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10) l.add(2) l.add(44)","right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def","# Obtain head nodes for left and right linked lists left_head = left.head","left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right)","2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node","linear time. ''' # Create a new linked list that contains nodes from","right, set current to left node if left_data < right_data: current.next_node = left_head","size = linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half =","unsorted list at the midpoint into sublists. Takes O(k log n) quasilinear time.","and right merged = LinkedList() # Add a fake head that is discarded","reach the tail node # of either while left_head or right_head: # If","either while left_head or right_head: # If the head node of the left","simplify code merged.add(0) # Set current to the head of the linked list","(c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList","merged list. Runs in O(n) linear time. ''' # Create a new linked","is discarded later to simplify code merged.add(0) # Set current to the head","node of right is None, we're past the tail # Add the tail","we reach the tail node # of either while left_head or right_head: #","# non-empty linked lists size = linked_list.size() midpoint = size // 2 mid_node","merged linkned list if left_head is None: current.next_node = right_head # Call next","by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. #","= left_head.next_node # If data on left is greater than right, set current","code merged.add(0) # Set current to the head of the linked list current","the left is None, we're past the tail # Add the node from","O(k log n) quasilinear time. ''' if linked_list == None or linked_list.head ==","node current = current.next_node # Discard fake head and set first merged node","node data to perform comparison operations left_data = left_head.data right_data = right_head.data #","right_data: current.next_node = left_head # Move left head to next node left_head =","head that is discarded later to simplify code merged.add(0) # Set current to","right_head = right.head # Iterate over left and right until we reach the","until we reach the tail node # of either while left_head or right_head:","the head node of the left is None, we're past the tail #","or linked_list.head == None: left_half = linked_list right_half = None return left_half, right_half","Returns a sorted linked list. Runs in O(kn log n) time. ''' if","linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half","data on left is greater than right, set current to right node else:","from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in","= right_head.next_node # Move current to next node current = current.next_node # Discard","= LinkedList() # Add a fake head that is discarded later to simplify","two linked lists, sorting by data in nodes. Returns a new, merged list.","right head to next node right_head = right_head.next_node # Move current to next","condition to False left_head = left_head.next_node else: # Not at either tail node","to False left_head = left_head.next_node else: # Not at either tail node #","right_data = right_head.data # If data on left is less than right, set","either tail node # Obtain node data to perform comparison operations left_data =","None or linked_list.head == None: left_half = linked_list right_half = None return left_half,","head to next node left_head = left_head.next_node # If data on left is","right is None, we're past the tail # Add the tail node from","3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list","next node right_head = right_head.next_node # Move current to next node current =","if linked_list == None or linked_list.head == None: left_half = linked_list right_half =","log n) quasilinear time. ''' if linked_list == None or linked_list.head == None:","a single node - Repeatedly merge the sublists to produce sorted swublists until","merge the sublists to produce sorted swublists until one remains Returns a sorted","left_half, right_half def merge(left, right): ''' Merges two linked lists, sorting by data","def merge_sort(linked_list): ''' Sorts a linked list in ascending order. - Recuresively divide","# Move current to next node current = current.next_node # Discard fake head","merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted","order. - Recuresively divide the linked list into sublists containing a single node","= size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList()","# Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights","right_head.next_node # If the head node of right is None, we're past the","on left is less than right, set current to left node if left_data","or right_head: # If the head node of the left is None, we're","If the head node of right is None, we're past the tail #","mid_node.next_node = None return left_half, right_half def merge(left, right): ''' Merges two linked","later to simplify code merged.add(0) # Set current to the head of the","head nodes for left and right linked lists left_head = left.head right_head =","return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list =","left and right linked lists left_head = left.head right_head = right.head # Iterate","= current.next_node # Discard fake head and set first merged node as head","as head head = merged.head.next_node merged.head = head return merged l = LinkedList()","Add the node from right to merged linkned list if left_head is None:","= left.head right_head = right.head # Iterate over left and right until we","''' Merges two linked lists, sorting by data in nodes. Returns a new,","# Not at either tail node # Obtain node data to perform comparison","list elif right_head is None: current.next_node = left_head # Call next on left","== 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left","condition to False right_head = right_head.next_node # If the head node of right","we're past the tail # Add the node from right to merged linkned","current.next_node = right_head # Move right head to next node right_head = right_head.next_node","merging left and right merged = LinkedList() # Add a fake head that","n) quasilinear time. ''' if linked_list == None or linked_list.head == None: left_half","linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half","right, set current to right node else: current.next_node = right_head # Move right","''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half","a new linked list that contains nodes from # merging left and right","Returns a new, merged list. Runs in O(n) linear time. ''' # Create","# Add a fake head that is discarded later to simplify code merged.add(0)","from left to merged linked list elif right_head is None: current.next_node = left_head","# Move left head to next node left_head = left_head.next_node # If data","------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list","= linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node =","right) def split(linked_list): ''' Divide the unsorted list at the midpoint into sublists.","left_data = left_head.data right_data = right_head.data # If data on left is less","# If data on left is greater than right, set current to right","# Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import","Obtain head nodes for left and right linked lists left_head = left.head right_head","Add a fake head that is discarded later to simplify code merged.add(0) #","left_head # Move left head to next node left_head = left_head.next_node # If","# # Data Structures: Linked List Merge Sort: The Conquer Step # Python","Merges two linked lists, sorting by data in nodes. Returns a new, merged","current to right node else: current.next_node = right_head # Move right head to","the linked list current = merged.head # Obtain head nodes for left and","list. Runs in O(kn log n) time. ''' if linked_list.size() == 1: return","node of the left is None, we're past the tail # Add the","= LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left,","1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left =","the tail node from left to merged linked list elif right_head is None:","linked list into sublists containing a single node - Repeatedly merge the sublists","If data on left is less than right, set current to left node","Create a new linked list that contains nodes from # merging left and","left and right merged = LinkedList() # Add a fake head that is","= merged.head # Obtain head nodes for left and right linked lists left_head","the tail # Add the node from right to merged linkned list if","''' # Create a new linked list that contains nodes from # merging","list at the midpoint into sublists. Takes O(k log n) quasilinear time. '''","to False right_head = right_head.next_node # If the head node of right is","Conquer Step # Python Techdegree # # Created by <NAME> on 3/24/19. #","left to merged linked list elif right_head is None: current.next_node = left_head #","current to left node if left_data < right_data: current.next_node = left_head # Move","head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list","l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list = merge_sort(l) print(sorted_linked_list)","sorted swublists until one remains Returns a sorted linked list. Runs in O(kn","node right_head = right_head.next_node # Move current to next node current = current.next_node","in O(kn log n) time. ''' if linked_list.size() == 1: return linked_list elif","Repeatedly merge the sublists to produce sorted swublists until one remains Returns a","return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return","current.next_node = left_head # Call next on left to set loop condition to","tail node # of either while left_head or right_head: # If the head","def merge(left, right): ''' Merges two linked lists, sorting by data in nodes.","in O(n) linear time. ''' # Create a new linked list that contains","to merged linkned list if left_head is None: current.next_node = right_head # Call","new, merged list. Runs in O(n) linear time. ''' # Create a new","linked_list == None or linked_list.head == None: left_half = linked_list right_half = None","that contains nodes from # merging left and right merged = LinkedList() #","time. ''' if linked_list == None or linked_list.head == None: left_half = linked_list","of right is None, we're past the tail # Add the tail node","<NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------","# If the head node of right is None, we're past the tail","# # Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All","right_half else: # non-empty linked lists size = linked_list.size() midpoint = size //","right until we reach the tail node # of either while left_head or","the head of the linked list current = merged.head # Obtain head nodes","merged linked list elif right_head is None: current.next_node = left_head # Call next","left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide","over left and right until we reach the tail node # of either","contains nodes from # merging left and right merged = LinkedList() # Add","merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15)","Divide the unsorted list at the midpoint into sublists. Takes O(k log n)","list current = merged.head # Obtain head nodes for left and right linked","a new, merged list. Runs in O(n) linear time. ''' # Create a","False right_head = right_head.next_node # If the head node of right is None,","on left to set loop condition to False left_head = left_head.next_node else: #","node as head head = merged.head.next_node merged.head = head return merged l =","linkned list if left_head is None: current.next_node = right_head # Call next on","linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None","# Add the node from right to merged linkned list if left_head is","The Conquer Step # Python Techdegree # # Created by <NAME> on 3/24/19.","O(n) linear time. ''' # Create a new linked list that contains nodes","linked list in ascending order. - Recuresively divide the linked list into sublists","def split(linked_list): ''' Divide the unsorted list at the midpoint into sublists. Takes","is None: current.next_node = right_head # Call next on right to set loop","past the tail # Add the node from right to merged linkned list","node left_head = left_head.next_node # If data on left is greater than right,","= left_head # Move left head to next node left_head = left_head.next_node #","= right_head # Call next on right to set loop condition to False","midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half =","left_head = left.head right_head = right.head # Iterate over left and right until","None, we're past the tail # Add the node from right to merged","# Set current to the head of the linked list current = merged.head","current.next_node = right_head # Call next on right to set loop condition to","to produce sorted swublists until one remains Returns a sorted linked list. Runs","Linked List Merge Sort: The Conquer Step # Python Techdegree # # Created","linked_list.head == None: left_half = linked_list right_half = None return left_half, right_half else:","LinkedList() # Add a fake head that is discarded later to simplify code","left_half, right_half else: # non-empty linked lists size = linked_list.size() midpoint = size","greater than right, set current to right node else: current.next_node = right_head #","Data Structures: Linked List Merge Sort: The Conquer Step # Python Techdegree #","elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right =","set first merged node as head head = merged.head.next_node merged.head = head return","Iterate over left and right until we reach the tail node # of","Step # Python Techdegree # # Created by <NAME> on 3/24/19. # Copyright","new linked list that contains nodes from # merging left and right merged","left_head.next_node else: # Not at either tail node # Obtain node data to","list in ascending order. - Recuresively divide the linked list into sublists containing","right_head: # If the head node of the left is None, we're past","If data on left is greater than right, set current to right node","next on left to set loop condition to False left_head = left_head.next_node else:","# Data Structures: Linked List Merge Sort: The Conquer Step # Python Techdegree","''' Divide the unsorted list at the midpoint into sublists. Takes O(k log","left_head.data right_data = right_head.data # If data on left is less than right,","size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half","linked lists left_head = left.head right_head = right.head # Iterate over left and","right_head.data # If data on left is less than right, set current to","rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts","merged.head # Obtain head nodes for left and right linked lists left_head =","2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def","into sublists. Takes O(k log n) quasilinear time. ''' if linked_list == None","log n) time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return","# Obtain node data to perform comparison operations left_data = left_head.data right_data =","right): ''' Merges two linked lists, sorting by data in nodes. Returns a","loop condition to False right_head = right_head.next_node # If the head node of","at the midpoint into sublists. Takes O(k log n) quasilinear time. ''' if","sublists to produce sorted swublists until one remains Returns a sorted linked list.","= linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list","ascending order. - Recuresively divide the linked list into sublists containing a single","single node - Repeatedly merge the sublists to produce sorted swublists until one","split(linked_list): ''' Divide the unsorted list at the midpoint into sublists. Takes O(k","left_head # Call next on left to set loop condition to False left_head","right_head = right_head.next_node # If the head node of right is None, we're","Recuresively divide the linked list into sublists containing a single node - Repeatedly","elif right_head is None: current.next_node = left_head # Call next on left to","head node of right is None, we're past the tail # Add the","head node of the left is None, we're past the tail # Add","if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half =","Discard fake head and set first merged node as head head = merged.head.next_node","# Iterate over left and right until we reach the tail node #","node else: current.next_node = right_head # Move right head to next node right_head","left_head = left_head.next_node else: # Not at either tail node # Obtain node","None: current.next_node = left_head # Call next on left to set loop condition","# Discard fake head and set first merged node as head head =","= right_head.next_node # If the head node of right is None, we're past","of the left is None, we're past the tail # Add the node","perform comparison operations left_data = left_head.data right_data = right_head.data # If data on","= None return left_half, right_half else: # non-empty linked lists size = linked_list.size()","left and right until we reach the tail node # of either while","left is less than right, set current to left node if left_data <","= linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half,","if left_head is None: current.next_node = right_head # Call next on right to","quasilinear time. ''' if linked_list == None or linked_list.head == None: left_half =","left node if left_data < right_data: current.next_node = left_head # Move left head","fake head and set first merged node as head head = merged.head.next_node merged.head","# ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked","comparison operations left_data = left_head.data right_data = right_head.data # If data on left","to next node left_head = left_head.next_node # If data on left is greater","lists, sorting by data in nodes. Returns a new, merged list. Runs in","ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list):","If the head node of the left is None, we're past the tail","Python Techdegree # # Created by <NAME> on 3/24/19. # Copyright (c) 2019","on right to set loop condition to False right_head = right_head.next_node # If","for left and right linked lists left_head = left.head right_head = right.head #","a fake head that is discarded later to simplify code merged.add(0) # Set","merged node as head head = merged.head.next_node merged.head = head return merged l","time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half,","split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): '''","tail # Add the tail node from left to merged linked list elif","return merge(left, right) def split(linked_list): ''' Divide the unsorted list at the midpoint","List Merge Sort: The Conquer Step # Python Techdegree # # Created by","on left is greater than right, set current to right node else: current.next_node","less than right, set current to left node if left_data < right_data: current.next_node","False left_head = left_head.next_node else: # Not at either tail node # Obtain","next on right to set loop condition to False right_head = right_head.next_node #","right_half def merge(left, right): ''' Merges two linked lists, sorting by data in","containing a single node - Repeatedly merge the sublists to produce sorted swublists","left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return","the midpoint into sublists. Takes O(k log n) quasilinear time. ''' if linked_list","sublists. Takes O(k log n) quasilinear time. ''' if linked_list == None or","Runs in O(kn log n) time. ''' if linked_list.size() == 1: return linked_list","to merged linked list elif right_head is None: current.next_node = left_head # Call","current to next node current = current.next_node # Discard fake head and set","data in nodes. Returns a new, merged list. Runs in O(n) linear time.","Call next on left to set loop condition to False left_head = left_head.next_node","to perform comparison operations left_data = left_head.data right_data = right_head.data # If data","right node else: current.next_node = right_head # Move right head to next node","current.next_node # Discard fake head and set first merged node as head head","left_head or right_head: # If the head node of the left is None,","the tail # Add the tail node from left to merged linked list","while left_head or right_head: # If the head node of the left is","sorted linked list. Runs in O(kn log n) time. ''' if linked_list.size() ==","Move right head to next node right_head = right_head.next_node # Move current to","linked lists, sorting by data in nodes. Returns a new, merged list. Runs","remains Returns a sorted linked list. Runs in O(kn log n) time. '''","Move left head to next node left_head = left_head.next_node # If data on","= right_head.data # If data on left is less than right, set current","left is greater than right, set current to right node else: current.next_node =","n) time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list","linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half)","tail node # Obtain node data to perform comparison operations left_data = left_head.data","is None, we're past the tail # Add the node from right to","right merged = LinkedList() # Add a fake head that is discarded later","node - Repeatedly merge the sublists to produce sorted swublists until one remains","divide the linked list into sublists containing a single node - Repeatedly merge","else: # Not at either tail node # Obtain node data to perform","Sorts a linked list in ascending order. - Recuresively divide the linked list","by data in nodes. Returns a new, merged list. Runs in O(n) linear","operations left_data = left_head.data right_data = right_head.data # If data on left is","right to merged linkned list if left_head is None: current.next_node = right_head #","head head = merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10)","import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending order.","head = merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10) l.add(2)","node if left_data < right_data: current.next_node = left_head # Move left head to","== None or linked_list.head == None: left_half = linked_list right_half = None return","linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list)","merged.add(0) # Set current to the head of the linked list current =","node # of either while left_head or right_head: # If the head node","sublists containing a single node - Repeatedly merge the sublists to produce sorted","is None: current.next_node = left_head # Call next on left to set loop","''' Sorts a linked list in ascending order. - Recuresively divide the linked","Takes O(k log n) quasilinear time. ''' if linked_list == None or linked_list.head","= left_head.next_node else: # Not at either tail node # Obtain node data","return left_half, right_half else: # non-empty linked lists size = linked_list.size() midpoint =","and right until we reach the tail node # of either while left_head","Obtain node data to perform comparison operations left_data = left_head.data right_data = right_head.data","= right_head # Move right head to next node right_head = right_head.next_node #","is None, we're past the tail # Add the tail node from left","tail node from left to merged linked list elif right_head is None: current.next_node","Structures: Linked List Merge Sort: The Conquer Step # Python Techdegree # #","Merge Sort: The Conquer Step # Python Techdegree # # Created by <NAME>","left_half = linked_list right_half = None return left_half, right_half else: # non-empty linked","Move current to next node current = current.next_node # Discard fake head and","list. Runs in O(n) linear time. ''' # Create a new linked list","right linked lists left_head = left.head right_head = right.head # Iterate over left","the node from right to merged linkned list if left_head is None: current.next_node","on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from","Set current to the head of the linked list current = merged.head #","one remains Returns a sorted linked list. Runs in O(kn log n) time.","next node current = current.next_node # Discard fake head and set first merged","Sort: The Conquer Step # Python Techdegree # # Created by <NAME> on","until one remains Returns a sorted linked list. Runs in O(kn log n)","# of either while left_head or right_head: # If the head node of","Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending order. -","to left node if left_data < right_data: current.next_node = left_head # Move left","# Add the tail node from left to merged linked list elif right_head","right to set loop condition to False right_head = right_head.next_node # If the","merged.head = head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200)","Runs in O(n) linear time. ''' # Create a new linked list that","sorting by data in nodes. Returns a new, merged list. Runs in O(n)","None return left_half, right_half else: # non-empty linked lists size = linked_list.size() midpoint","left is None, we're past the tail # Add the node from right","linked list current = merged.head # Obtain head nodes for left and right","current = merged.head # Obtain head nodes for left and right linked lists","left_head = left_head.next_node # If data on left is greater than right, set","nodes for left and right linked lists left_head = left.head right_head = right.head","Add the tail node from left to merged linked list elif right_head is","we're past the tail # Add the tail node from left to merged","list into sublists containing a single node - Repeatedly merge the sublists to","= None return left_half, right_half def merge(left, right): ''' Merges two linked lists,","set loop condition to False left_head = left_head.next_node else: # Not at either","LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right):","nodes. Returns a new, merged list. Runs in O(n) linear time. ''' #","Call next on right to set loop condition to False right_head = right_head.next_node","head to next node right_head = right_head.next_node # Move current to next node","= split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list):","reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a","to the head of the linked list current = merged.head # Obtain head","node from right to merged linkned list if left_head is None: current.next_node =","right_head is None: current.next_node = left_head # Call next on left to set","else: # non-empty linked lists size = linked_list.size() midpoint = size // 2","in nodes. Returns a new, merged list. Runs in O(n) linear time. '''","to set loop condition to False right_head = right_head.next_node # If the head","produce sorted swublists until one remains Returns a sorted linked list. Runs in","of the linked list current = merged.head # Obtain head nodes for left","linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right","loop condition to False left_head = left_head.next_node else: # Not at either tail","next node left_head = left_head.next_node # If data on left is greater than"],"string":"[\n \"the unsorted list at the midpoint into sublists. Takes O(k log n) quasilinear\",\n \"the linked list into sublists containing a single node - Repeatedly merge the\",\n \"right_head.next_node # Move current to next node current = current.next_node # Discard fake\",\n \"set loop condition to False right_head = right_head.next_node # If the head node\",\n \"is greater than right, set current to right node else: current.next_node = right_head\",\n \"left_head is None: current.next_node = right_head # Call next on right to set\",\n \"from right to merged linkned list if left_head is None: current.next_node = right_head\",\n \"to set loop condition to False left_head = left_head.next_node else: # Not at\",\n \"if left_data < right_data: current.next_node = left_head # Move left head to next\",\n \"All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): '''\",\n \"linked list that contains nodes from # merging left and right merged =\",\n \"Not at either tail node # Obtain node data to perform comparison operations\",\n \"merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted list at the\",\n \"the sublists to produce sorted swublists until one remains Returns a sorted linked\",\n \"lists left_head = left.head right_head = right.head # Iterate over left and right\",\n \"past the tail # Add the tail node from left to merged linked\",\n \"return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half)\",\n \"merge_sort(linked_list): ''' Sorts a linked list in ascending order. - Recuresively divide the\",\n \"right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def\",\n \"midpoint into sublists. Takes O(k log n) quasilinear time. ''' if linked_list ==\",\n \"head of the linked list current = merged.head # Obtain head nodes for\",\n \"# If the head node of the left is None, we're past the\",\n \"= merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted list at\",\n \"= linked_list right_half = None return left_half, right_half else: # non-empty linked lists\",\n \"at either tail node # Obtain node data to perform comparison operations left_data\",\n \"merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list = merge_sort(l)\",\n \"left_head.next_node # If data on left is greater than right, set current to\",\n \"data on left is less than right, set current to left node if\",\n \"non-empty linked lists size = linked_list.size() midpoint = size // 2 mid_node =\",\n \"left.head right_head = right.head # Iterate over left and right until we reach\",\n \"O(kn log n) time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty():\",\n \"= mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right): ''' Merges\",\n \"None, we're past the tail # Add the tail node from left to\",\n \"right_head = right_head.next_node # Move current to next node current = current.next_node #\",\n \"# Python Techdegree # # Created by <NAME> on 3/24/19. # Copyright (c)\",\n \"the head node of right is None, we're past the tail # Add\",\n \"a sorted linked list. Runs in O(kn log n) time. ''' if linked_list.size()\",\n \"- Repeatedly merge the sublists to produce sorted swublists until one remains Returns\",\n \"from # merging left and right merged = LinkedList() # Add a fake\",\n \"fake head that is discarded later to simplify code merged.add(0) # Set current\",\n \"first merged node as head head = merged.head.next_node merged.head = head return merged\",\n \"a linked list in ascending order. - Recuresively divide the linked list into\",\n \"merged = LinkedList() # Add a fake head that is discarded later to\",\n \"= left_head.data right_data = right_head.data # If data on left is less than\",\n \"mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node\",\n \"tail # Add the node from right to merged linkned list if left_head\",\n \"to next node right_head = right_head.next_node # Move current to next node current\",\n \"None: left_half = linked_list right_half = None return left_half, right_half else: # non-empty\",\n \"= merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the\",\n \"in ascending order. - Recuresively divide the linked list into sublists containing a\",\n \"of either while left_head or right_head: # If the head node of the\",\n \"right_head # Move right head to next node right_head = right_head.next_node # Move\",\n \"<gh_stars>10-100 # # Data Structures: Linked List Merge Sort: The Conquer Step #\",\n \"than right, set current to left node if left_data < right_data: current.next_node =\",\n \"linked list. Runs in O(kn log n) time. ''' if linked_list.size() == 1:\",\n \"than right, set current to right node else: current.next_node = right_head # Move\",\n \"# Move right head to next node right_head = right_head.next_node # Move current\",\n \"linked_list right_half = None return left_half, right_half else: # non-empty linked lists size\",\n \"left head to next node left_head = left_head.next_node # If data on left\",\n \"lists size = linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half\",\n \"# Call next on right to set loop condition to False right_head =\",\n \"right_half = None return left_half, right_half else: # non-empty linked lists size =\",\n \"list if left_head is None: current.next_node = right_head # Call next on right\",\n \"and set first merged node as head head = merged.head.next_node merged.head = head\",\n \"linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left,\",\n \"time. ''' # Create a new linked list that contains nodes from #\",\n \"LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending order. - Recuresively\",\n \"to simplify code merged.add(0) # Set current to the head of the linked\",\n \"Techdegree # # Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps.\",\n \"node # Obtain node data to perform comparison operations left_data = left_head.data right_data\",\n \"head and set first merged node as head head = merged.head.next_node merged.head =\",\n \"merge(left, right): ''' Merges two linked lists, sorting by data in nodes. Returns\",\n \"None: current.next_node = right_head # Call next on right to set loop condition\",\n \"= head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l)\",\n \"# merging left and right merged = LinkedList() # Add a fake head\",\n \"swublists until one remains Returns a sorted linked list. Runs in O(kn log\",\n \"node from left to merged linked list elif right_head is None: current.next_node =\",\n \"// 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half =\",\n \"discarded later to simplify code merged.add(0) # Set current to the head of\",\n \"right_head # Call next on right to set loop condition to False right_head\",\n \"linked lists size = linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1)\",\n \"linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending\",\n \"= left_head # Call next on left to set loop condition to False\",\n \"Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved.\",\n \"mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right): ''' Merges two\",\n \"# Create a new linked list that contains nodes from # merging left\",\n \"< right_data: current.next_node = left_head # Move left head to next node left_head\",\n \"None return left_half, right_half def merge(left, right): ''' Merges two linked lists, sorting\",\n \"linked list elif right_head is None: current.next_node = left_head # Call next on\",\n \"the tail node # of either while left_head or right_head: # If the\",\n \"right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted list\",\n \"= right.head # Iterate over left and right until we reach the tail\",\n \"right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right): '''\",\n \"left_data < right_data: current.next_node = left_head # Move left head to next node\",\n \"- Recuresively divide the linked list into sublists containing a single node -\",\n \"nodes from # merging left and right merged = LinkedList() # Add a\",\n \"current to the head of the linked list current = merged.head # Obtain\",\n \"list that contains nodes from # merging left and right merged = LinkedList()\",\n \"Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node,\",\n \"to next node current = current.next_node # Discard fake head and set first\",\n \"into sublists containing a single node - Repeatedly merge the sublists to produce\",\n \"is less than right, set current to left node if left_data < right_data:\",\n \"return left_half, right_half def merge(left, right): ''' Merges two linked lists, sorting by\",\n \"set current to left node if left_data < right_data: current.next_node = left_head #\",\n \"current = current.next_node # Discard fake head and set first merged node as\",\n \"that is discarded later to simplify code merged.add(0) # Set current to the\",\n \"and right linked lists left_head = left.head right_head = right.head # Iterate over\",\n \"to right node else: current.next_node = right_head # Move right head to next\",\n \"set current to right node else: current.next_node = right_head # Move right head\",\n \"''' if linked_list == None or linked_list.head == None: left_half = linked_list right_half\",\n \"else: current.next_node = right_head # Move right head to next node right_head =\",\n \"current.next_node = left_head # Move left head to next node left_head = left_head.next_node\",\n \"data to perform comparison operations left_data = left_head.data right_data = right_head.data # If\",\n \"merge(left, right) def split(linked_list): ''' Divide the unsorted list at the midpoint into\",\n \"# Call next on left to set loop condition to False left_head =\",\n \"right.head # Iterate over left and right until we reach the tail node\",\n \"left to set loop condition to False left_head = left_head.next_node else: # Not\",\n \"# If data on left is less than right, set current to left\",\n \"== None: left_half = linked_list right_half = None return left_half, right_half else: #\",\n \"= merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10) l.add(2) l.add(44)\",\n \"right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def\",\n \"# Obtain head nodes for left and right linked lists left_head = left.head\",\n \"left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right)\",\n \"2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node\",\n \"linear time. ''' # Create a new linked list that contains nodes from\",\n \"right, set current to left node if left_data < right_data: current.next_node = left_head\",\n \"size = linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half =\",\n \"unsorted list at the midpoint into sublists. Takes O(k log n) quasilinear time.\",\n \"and right merged = LinkedList() # Add a fake head that is discarded\",\n \"reach the tail node # of either while left_head or right_head: # If\",\n \"either while left_head or right_head: # If the head node of the left\",\n \"simplify code merged.add(0) # Set current to the head of the linked list\",\n \"(c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList\",\n \"merged list. Runs in O(n) linear time. ''' # Create a new linked\",\n \"is discarded later to simplify code merged.add(0) # Set current to the head\",\n \"node of right is None, we're past the tail # Add the tail\",\n \"we reach the tail node # of either while left_head or right_head: #\",\n \"# non-empty linked lists size = linked_list.size() midpoint = size // 2 mid_node\",\n \"merged linkned list if left_head is None: current.next_node = right_head # Call next\",\n \"by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. #\",\n \"= left_head.next_node # If data on left is greater than right, set current\",\n \"code merged.add(0) # Set current to the head of the linked list current\",\n \"the left is None, we're past the tail # Add the node from\",\n \"O(k log n) quasilinear time. ''' if linked_list == None or linked_list.head ==\",\n \"node current = current.next_node # Discard fake head and set first merged node\",\n \"node data to perform comparison operations left_data = left_head.data right_data = right_head.data #\",\n \"right_data: current.next_node = left_head # Move left head to next node left_head =\",\n \"head that is discarded later to simplify code merged.add(0) # Set current to\",\n \"right_head = right.head # Iterate over left and right until we reach the\",\n \"until we reach the tail node # of either while left_head or right_head:\",\n \"the head node of the left is None, we're past the tail #\",\n \"or linked_list.head == None: left_half = linked_list right_half = None return left_half, right_half\",\n \"Returns a sorted linked list. Runs in O(kn log n) time. ''' if\",\n \"linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half\",\n \"data on left is greater than right, set current to right node else:\",\n \"from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in\",\n \"= right_head.next_node # Move current to next node current = current.next_node # Discard\",\n \"= LinkedList() # Add a fake head that is discarded later to simplify\",\n \"two linked lists, sorting by data in nodes. Returns a new, merged list.\",\n \"right head to next node right_head = right_head.next_node # Move current to next\",\n \"condition to False left_head = left_head.next_node else: # Not at either tail node\",\n \"to False left_head = left_head.next_node else: # Not at either tail node #\",\n \"right_data = right_head.data # If data on left is less than right, set\",\n \"either tail node # Obtain node data to perform comparison operations left_data =\",\n \"None or linked_list.head == None: left_half = linked_list right_half = None return left_half,\",\n \"head to next node left_head = left_head.next_node # If data on left is\",\n \"right is None, we're past the tail # Add the tail node from\",\n \"3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list\",\n \"next node right_head = right_head.next_node # Move current to next node current =\",\n \"if linked_list == None or linked_list.head == None: left_half = linked_list right_half =\",\n \"log n) quasilinear time. ''' if linked_list == None or linked_list.head == None:\",\n \"a single node - Repeatedly merge the sublists to produce sorted swublists until\",\n \"merge the sublists to produce sorted swublists until one remains Returns a sorted\",\n \"left_half, right_half def merge(left, right): ''' Merges two linked lists, sorting by data\",\n \"def merge_sort(linked_list): ''' Sorts a linked list in ascending order. - Recuresively divide\",\n \"# Move current to next node current = current.next_node # Discard fake head\",\n \"merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide the unsorted\",\n \"order. - Recuresively divide the linked list into sublists containing a single node\",\n \"= size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList()\",\n \"# Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights\",\n \"right_head.next_node # If the head node of right is None, we're past the\",\n \"on left is less than right, set current to left node if left_data\",\n \"or right_head: # If the head node of the left is None, we're\",\n \"If the head node of right is None, we're past the tail #\",\n \"mid_node.next_node = None return left_half, right_half def merge(left, right): ''' Merges two linked\",\n \"later to simplify code merged.add(0) # Set current to the head of the\",\n \"head nodes for left and right linked lists left_head = left.head right_head =\",\n \"return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list =\",\n \"left and right linked lists left_head = left.head right_head = right.head # Iterate\",\n \"= current.next_node # Discard fake head and set first merged node as head\",\n \"as head head = merged.head.next_node merged.head = head return merged l = LinkedList()\",\n \"Add the node from right to merged linkned list if left_head is None:\",\n \"= left.head right_head = right.head # Iterate over left and right until we\",\n \"''' Merges two linked lists, sorting by data in nodes. Returns a new,\",\n \"# Not at either tail node # Obtain node data to perform comparison\",\n \"list elif right_head is None: current.next_node = left_head # Call next on left\",\n \"== 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left\",\n \"condition to False right_head = right_head.next_node # If the head node of right\",\n \"we're past the tail # Add the node from right to merged linkned\",\n \"current.next_node = right_head # Move right head to next node right_head = right_head.next_node\",\n \"merging left and right merged = LinkedList() # Add a fake head that\",\n \"n) quasilinear time. ''' if linked_list == None or linked_list.head == None: left_half\",\n \"linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half\",\n \"right, set current to right node else: current.next_node = right_head # Move right\",\n \"''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half\",\n \"a new linked list that contains nodes from # merging left and right\",\n \"Returns a new, merged list. Runs in O(n) linear time. ''' # Create\",\n \"# Add a fake head that is discarded later to simplify code merged.add(0)\",\n \"from left to merged linked list elif right_head is None: current.next_node = left_head\",\n \"# Move left head to next node left_head = left_head.next_node # If data\",\n \"------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list\",\n \"= linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node =\",\n \"right) def split(linked_list): ''' Divide the unsorted list at the midpoint into sublists.\",\n \"left_data = left_head.data right_data = right_head.data # If data on left is less\",\n \"# If data on left is greater than right, set current to right\",\n \"# Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import\",\n \"Obtain head nodes for left and right linked lists left_head = left.head right_head\",\n \"Add a fake head that is discarded later to simplify code merged.add(0) #\",\n \"left_head # Move left head to next node left_head = left_head.next_node # If\",\n \"# # Data Structures: Linked List Merge Sort: The Conquer Step # Python\",\n \"Merges two linked lists, sorting by data in nodes. Returns a new, merged\",\n \"current to right node else: current.next_node = right_head # Move right head to\",\n \"the linked list current = merged.head # Obtain head nodes for left and\",\n \"list. Runs in O(kn log n) time. ''' if linked_list.size() == 1: return\",\n \"node of the left is None, we're past the tail # Add the\",\n \"= LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left,\",\n \"1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left =\",\n \"the tail node from left to merged linked list elif right_head is None:\",\n \"linked list into sublists containing a single node - Repeatedly merge the sublists\",\n \"If data on left is less than right, set current to left node\",\n \"Create a new linked list that contains nodes from # merging left and\",\n \"left and right merged = LinkedList() # Add a fake head that is\",\n \"= merged.head # Obtain head nodes for left and right linked lists left_head\",\n \"the tail # Add the node from right to merged linkned list if\",\n \"''' # Create a new linked list that contains nodes from # merging\",\n \"list at the midpoint into sublists. Takes O(k log n) quasilinear time. '''\",\n \"to False right_head = right_head.next_node # If the head node of right is\",\n \"Conquer Step # Python Techdegree # # Created by <NAME> on 3/24/19. #\",\n \"left to merged linked list elif right_head is None: current.next_node = left_head #\",\n \"current to left node if left_data < right_data: current.next_node = left_head # Move\",\n \"head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list\",\n \"l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200) print(l) sorted_linked_list = merge_sort(l) print(sorted_linked_list)\",\n \"sorted swublists until one remains Returns a sorted linked list. Runs in O(kn\",\n \"node right_head = right_head.next_node # Move current to next node current = current.next_node\",\n \"in O(kn log n) time. ''' if linked_list.size() == 1: return linked_list elif\",\n \"Repeatedly merge the sublists to produce sorted swublists until one remains Returns a\",\n \"return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return\",\n \"current.next_node = left_head # Call next on left to set loop condition to\",\n \"tail node # of either while left_head or right_head: # If the head\",\n \"def merge(left, right): ''' Merges two linked lists, sorting by data in nodes.\",\n \"in O(n) linear time. ''' # Create a new linked list that contains\",\n \"to merged linkned list if left_head is None: current.next_node = right_head # Call\",\n \"new, merged list. Runs in O(n) linear time. ''' # Create a new\",\n \"linked_list == None or linked_list.head == None: left_half = linked_list right_half = None\",\n \"that contains nodes from # merging left and right merged = LinkedList() #\",\n \"time. ''' if linked_list == None or linked_list.head == None: left_half = linked_list\",\n \"of right is None, we're past the tail # Add the tail node\",\n \"<NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------\",\n \"# If the head node of right is None, we're past the tail\",\n \"# # Created by <NAME> on 3/24/19. # Copyright (c) 2019 ddApps. All\",\n \"right_half else: # non-empty linked lists size = linked_list.size() midpoint = size //\",\n \"right until we reach the tail node # of either while left_head or\",\n \"the head of the linked list current = merged.head # Obtain head nodes\",\n \"merged linked list elif right_head is None: current.next_node = left_head # Call next\",\n \"left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): ''' Divide\",\n \"over left and right until we reach the tail node # of either\",\n \"contains nodes from # merging left and right merged = LinkedList() # Add\",\n \"merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15)\",\n \"Divide the unsorted list at the midpoint into sublists. Takes O(k log n)\",\n \"list current = merged.head # Obtain head nodes for left and right linked\",\n \"a new, merged list. Runs in O(n) linear time. ''' # Create a\",\n \"False right_head = right_head.next_node # If the head node of right is None,\",\n \"on left to set loop condition to False left_head = left_head.next_node else: #\",\n \"node as head head = merged.head.next_node merged.head = head return merged l =\",\n \"linkned list if left_head is None: current.next_node = right_head # Call next on\",\n \"linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None\",\n \"# Add the node from right to merged linkned list if left_head is\",\n \"The Conquer Step # Python Techdegree # # Created by <NAME> on 3/24/19.\",\n \"O(n) linear time. ''' # Create a new linked list that contains nodes\",\n \"linked list in ascending order. - Recuresively divide the linked list into sublists\",\n \"def split(linked_list): ''' Divide the unsorted list at the midpoint into sublists. Takes\",\n \"is None: current.next_node = right_head # Call next on right to set loop\",\n \"past the tail # Add the node from right to merged linkned list\",\n \"node left_head = left_head.next_node # If data on left is greater than right,\",\n \"= left_head # Move left head to next node left_head = left_head.next_node #\",\n \"= right_head # Call next on right to set loop condition to False\",\n \"midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half =\",\n \"left_head = left.head right_head = right.head # Iterate over left and right until\",\n \"None, we're past the tail # Add the node from right to merged\",\n \"# Set current to the head of the linked list current = merged.head\",\n \"current.next_node = right_head # Call next on right to set loop condition to\",\n \"to produce sorted swublists until one remains Returns a sorted linked list. Runs\",\n \"Linked List Merge Sort: The Conquer Step # Python Techdegree # # Created\",\n \"linked_list.head == None: left_half = linked_list right_half = None return left_half, right_half else:\",\n \"LinkedList() # Add a fake head that is discarded later to simplify code\",\n \"left_half, right_half else: # non-empty linked lists size = linked_list.size() midpoint = size\",\n \"greater than right, set current to right node else: current.next_node = right_head #\",\n \"Data Structures: Linked List Merge Sort: The Conquer Step # Python Techdegree #\",\n \"elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right =\",\n \"set first merged node as head head = merged.head.next_node merged.head = head return\",\n \"Iterate over left and right until we reach the tail node # of\",\n \"Step # Python Techdegree # # Created by <NAME> on 3/24/19. # Copyright\",\n \"new linked list that contains nodes from # merging left and right merged\",\n \"left_head.next_node else: # Not at either tail node # Obtain node data to\",\n \"list in ascending order. - Recuresively divide the linked list into sublists containing\",\n \"right_head: # If the head node of the left is None, we're past\",\n \"If data on left is greater than right, set current to right node\",\n \"next on left to set loop condition to False left_head = left_head.next_node else:\",\n \"# Data Structures: Linked List Merge Sort: The Conquer Step # Python Techdegree\",\n \"''' Divide the unsorted list at the midpoint into sublists. Takes O(k log\",\n \"left_head.data right_data = right_head.data # If data on left is less than right,\",\n \"size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list right_half = LinkedList() right_half\",\n \"linked lists left_head = left.head right_head = right.head # Iterate over left and\",\n \"right_head.data # If data on left is less than right, set current to\",\n \"rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts\",\n \"merged.head # Obtain head nodes for left and right linked lists left_head =\",\n \"2019 ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def\",\n \"into sublists. Takes O(k log n) quasilinear time. ''' if linked_list == None\",\n \"log n) time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return\",\n \"# Obtain node data to perform comparison operations left_data = left_head.data right_data =\",\n \"right): ''' Merges two linked lists, sorting by data in nodes. Returns a\",\n \"loop condition to False right_head = right_head.next_node # If the head node of\",\n \"at the midpoint into sublists. Takes O(k log n) quasilinear time. ''' if\",\n \"sublists to produce sorted swublists until one remains Returns a sorted linked list.\",\n \"= linked_list.size() midpoint = size // 2 mid_node = linked_list.node_at_index(midpoint-1) left_half = linked_list\",\n \"ascending order. - Recuresively divide the linked list into sublists containing a single\",\n \"single node - Repeatedly merge the sublists to produce sorted swublists until one\",\n \"split(linked_list): ''' Divide the unsorted list at the midpoint into sublists. Takes O(k\",\n \"left_head # Call next on left to set loop condition to False left_head\",\n \"right_head = right_head.next_node # If the head node of right is None, we're\",\n \"Recuresively divide the linked list into sublists containing a single node - Repeatedly\",\n \"elif right_head is None: current.next_node = left_head # Call next on left to\",\n \"head node of right is None, we're past the tail # Add the\",\n \"head node of the left is None, we're past the tail # Add\",\n \"if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half =\",\n \"Discard fake head and set first merged node as head head = merged.head.next_node\",\n \"# Iterate over left and right until we reach the tail node #\",\n \"node else: current.next_node = right_head # Move right head to next node right_head\",\n \"left_head = left_head.next_node else: # Not at either tail node # Obtain node\",\n \"None: current.next_node = left_head # Call next on left to set loop condition\",\n \"# Discard fake head and set first merged node as head head =\",\n \"= right_head.next_node # If the head node of right is None, we're past\",\n \"of the left is None, we're past the tail # Add the node\",\n \"perform comparison operations left_data = left_head.data right_data = right_head.data # If data on\",\n \"= None return left_half, right_half else: # non-empty linked lists size = linked_list.size()\",\n \"left and right until we reach the tail node # of either while\",\n \"left is less than right, set current to left node if left_data <\",\n \"= linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half,\",\n \"if left_head is None: current.next_node = right_head # Call next on right to\",\n \"quasilinear time. ''' if linked_list == None or linked_list.head == None: left_half =\",\n \"left node if left_data < right_data: current.next_node = left_head # Move left head\",\n \"fake head and set first merged node as head head = merged.head.next_node merged.head\",\n \"# ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked\",\n \"comparison operations left_data = left_head.data right_data = right_head.data # If data on left\",\n \"to next node left_head = left_head.next_node # If data on left is greater\",\n \"lists, sorting by data in nodes. Returns a new, merged list. Runs in\",\n \"ddApps. All rights reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list):\",\n \"If the head node of the left is None, we're past the tail\",\n \"Python Techdegree # # Created by <NAME> on 3/24/19. # Copyright (c) 2019\",\n \"on right to set loop condition to False right_head = right_head.next_node # If\",\n \"for left and right linked lists left_head = left.head right_head = right.head #\",\n \"a fake head that is discarded later to simplify code merged.add(0) # Set\",\n \"merged node as head head = merged.head.next_node merged.head = head return merged l\",\n \"time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half,\",\n \"split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list): '''\",\n \"tail # Add the tail node from left to merged linked list elif\",\n \"return merge(left, right) def split(linked_list): ''' Divide the unsorted list at the midpoint\",\n \"List Merge Sort: The Conquer Step # Python Techdegree # # Created by\",\n \"on left is greater than right, set current to right node else: current.next_node\",\n \"less than right, set current to left node if left_data < right_data: current.next_node\",\n \"False left_head = left_head.next_node else: # Not at either tail node # Obtain\",\n \"next on right to set loop condition to False right_head = right_head.next_node #\",\n \"right_half def merge(left, right): ''' Merges two linked lists, sorting by data in\",\n \"containing a single node - Repeatedly merge the sublists to produce sorted swublists\",\n \"left_half = linked_list right_half = LinkedList() right_half = mid_node.next_node mid_node.next_node = None return\",\n \"the midpoint into sublists. Takes O(k log n) quasilinear time. ''' if linked_list\",\n \"sublists. Takes O(k log n) quasilinear time. ''' if linked_list == None or\",\n \"Runs in O(kn log n) time. ''' if linked_list.size() == 1: return linked_list\",\n \"to merged linked list elif right_head is None: current.next_node = left_head # Call\",\n \"current to next node current = current.next_node # Discard fake head and set\",\n \"data in nodes. Returns a new, merged list. Runs in O(n) linear time.\",\n \"Call next on left to set loop condition to False left_head = left_head.next_node\",\n \"to perform comparison operations left_data = left_head.data right_data = right_head.data # If data\",\n \"right node else: current.next_node = right_head # Move right head to next node\",\n \"current.next_node # Discard fake head and set first merged node as head head\",\n \"left_head or right_head: # If the head node of the left is None,\",\n \"the tail # Add the tail node from left to merged linked list\",\n \"while left_head or right_head: # If the head node of the left is\",\n \"sorted linked list. Runs in O(kn log n) time. ''' if linked_list.size() ==\",\n \"Move right head to next node right_head = right_head.next_node # Move current to\",\n \"linked lists, sorting by data in nodes. Returns a new, merged list. Runs\",\n \"remains Returns a sorted linked list. Runs in O(kn log n) time. '''\",\n \"Move left head to next node left_head = left_head.next_node # If data on\",\n \"= right_head.data # If data on left is less than right, set current\",\n \"left is greater than right, set current to right node else: current.next_node =\",\n \"n) time. ''' if linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list\",\n \"linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half)\",\n \"tail node # Obtain node data to perform comparison operations left_data = left_head.data\",\n \"is None, we're past the tail # Add the node from right to\",\n \"right merged = LinkedList() # Add a fake head that is discarded later\",\n \"node - Repeatedly merge the sublists to produce sorted swublists until one remains\",\n \"divide the linked list into sublists containing a single node - Repeatedly merge\",\n \"else: # Not at either tail node # Obtain node data to perform\",\n \"Sorts a linked list in ascending order. - Recuresively divide the linked list\",\n \"by data in nodes. Returns a new, merged list. Runs in O(n) linear\",\n \"operations left_data = left_head.data right_data = right_head.data # If data on left is\",\n \"right to merged linkned list if left_head is None: current.next_node = right_head #\",\n \"head head = merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10)\",\n \"import Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending order.\",\n \"head = merged.head.next_node merged.head = head return merged l = LinkedList() l.add(10) l.add(2)\",\n \"node if left_data < right_data: current.next_node = left_head # Move left head to\",\n \"== None or linked_list.head == None: left_half = linked_list right_half = None return\",\n \"linked_list.size() == 1: return linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list)\",\n \"merged.add(0) # Set current to the head of the linked list current =\",\n \"node # of either while left_head or right_head: # If the head node\",\n \"sublists containing a single node - Repeatedly merge the sublists to produce sorted\",\n \"is None: current.next_node = left_head # Call next on left to set loop\",\n \"''' Sorts a linked list in ascending order. - Recuresively divide the linked\",\n \"Takes O(k log n) quasilinear time. ''' if linked_list == None or linked_list.head\",\n \"= left_head.next_node else: # Not at either tail node # Obtain node data\",\n \"return left_half, right_half else: # non-empty linked lists size = linked_list.size() midpoint =\",\n \"and right until we reach the tail node # of either while left_head\",\n \"Obtain node data to perform comparison operations left_data = left_head.data right_data = right_head.data\",\n \"= right_head # Move right head to next node right_head = right_head.next_node #\",\n \"is None, we're past the tail # Add the tail node from left\",\n \"tail node from left to merged linked list elif right_head is None: current.next_node\",\n \"Structures: Linked List Merge Sort: The Conquer Step # Python Techdegree # #\",\n \"Merge Sort: The Conquer Step # Python Techdegree # # Created by <NAME>\",\n \"left_half = linked_list right_half = None return left_half, right_half else: # non-empty linked\",\n \"Move current to next node current = current.next_node # Discard fake head and\",\n \"list. Runs in O(n) linear time. ''' # Create a new linked list\",\n \"right linked lists left_head = left.head right_head = right.head # Iterate over left\",\n \"the node from right to merged linkned list if left_head is None: current.next_node\",\n \"on 3/24/19. # Copyright (c) 2019 ddApps. All rights reserved. # ------------------------------------------------ from\",\n \"Set current to the head of the linked list current = merged.head #\",\n \"one remains Returns a sorted linked list. Runs in O(kn log n) time.\",\n \"next node current = current.next_node # Discard fake head and set first merged\",\n \"Sort: The Conquer Step # Python Techdegree # # Created by <NAME> on\",\n \"until one remains Returns a sorted linked list. Runs in O(kn log n)\",\n \"# of either while left_head or right_head: # If the head node of\",\n \"Node, LinkedList def merge_sort(linked_list): ''' Sorts a linked list in ascending order. -\",\n \"to left node if left_data < right_data: current.next_node = left_head # Move left\",\n \"# Add the tail node from left to merged linked list elif right_head\",\n \"right to set loop condition to False right_head = right_head.next_node # If the\",\n \"merged.head = head return merged l = LinkedList() l.add(10) l.add(2) l.add(44) l.add(15) l.add(200)\",\n \"Runs in O(n) linear time. ''' # Create a new linked list that\",\n \"sorting by data in nodes. Returns a new, merged list. Runs in O(n)\",\n \"None return left_half, right_half else: # non-empty linked lists size = linked_list.size() midpoint\",\n \"left is None, we're past the tail # Add the node from right\",\n \"linked list current = merged.head # Obtain head nodes for left and right\",\n \"current = merged.head # Obtain head nodes for left and right linked lists\",\n \"left_head = left_head.next_node # If data on left is greater than right, set\",\n \"nodes for left and right linked lists left_head = left.head right_head = right.head\",\n \"Add the tail node from left to merged linked list elif right_head is\",\n \"we're past the tail # Add the tail node from left to merged\",\n \"list into sublists containing a single node - Repeatedly merge the sublists to\",\n \"= None return left_half, right_half def merge(left, right): ''' Merges two linked lists,\",\n \"set loop condition to False left_head = left_head.next_node else: # Not at either\",\n \"LinkedList() right_half = mid_node.next_node mid_node.next_node = None return left_half, right_half def merge(left, right):\",\n \"nodes. Returns a new, merged list. Runs in O(n) linear time. ''' #\",\n \"Call next on right to set loop condition to False right_head = right_head.next_node\",\n \"head to next node right_head = right_head.next_node # Move current to next node\",\n \"= split(linked_list) left = merge_sort(left_half) right = merge_sort(right_half) return merge(left, right) def split(linked_list):\",\n \"reserved. # ------------------------------------------------ from linked_list import Node, LinkedList def merge_sort(linked_list): ''' Sorts a\",\n \"to the head of the linked list current = merged.head # Obtain head\",\n \"node from right to merged linkned list if left_head is None: current.next_node =\",\n \"right_head is None: current.next_node = left_head # Call next on left to set\",\n \"else: # non-empty linked lists size = linked_list.size() midpoint = size // 2\",\n \"in nodes. Returns a new, merged list. Runs in O(n) linear time. '''\",\n \"to set loop condition to False right_head = right_head.next_node # If the head\",\n \"produce sorted swublists until one remains Returns a sorted linked list. Runs in\",\n \"of the linked list current = merged.head # Obtain head nodes for left\",\n \"linked_list elif linked_list.is_empty(): return linked_list left_half, right_half = split(linked_list) left = merge_sort(left_half) right\",\n \"loop condition to False left_head = left_head.next_node else: # Not at either tail\",\n \"next node left_head = left_head.next_node # If data on left is greater than\"\n]","isConversational":false}}},{"rowIdx":289,"cells":{"ngram":{"kind":"list like","value":["TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.","k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index","EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,","= numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour distances with multiple","the Software without restriction, including without limitation the rights # to use, copy,","ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN","person obtaining a copy # of this software and associated documentation files (the","of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance())","Number of data points (dont do too much because of exact search) POINTS","A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR","SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #","range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance())","THE SOFTWARE. import numpy import scipy import unittest import time from nearpy import","to the following conditions: # The above copyright notice and this permission notice","# Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random","# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies","= time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random query vector","20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash","# Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random","above copyright notice and this permission notice shall be included in # all","to do so, subject to the following conditions: # The above copyright notice","dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() #","numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1","hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index","results = engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) # Real","in # all copies or substantial portions of the Software. # THE SOFTWARE","%d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in results]","POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create","is hereby granted, free of charge, to any person obtaining a copy #","HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create","# Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf =","print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results","persons to whom the Software is # furnished to do so, subject to","= time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash","= numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1","INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A","# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE","rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some","OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,","for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 =","documentation files (the \"Software\"), to deal # in the Software without restriction, including","Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors","= dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary hashes...')","to permit persons to whom the Software is # furnished to do so,","ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT,","points (dont do too much because of exact search) POINTS = 20000 ##########################################################","Do random query on engine 4 print('\\nNeighbour distances with multiple binary hashes:') print('","subject to the following conditions: # The above copyright notice and this permission","notice and this permission notice shall be included in # all copies or","of charge, to any person obtaining a copy # of this software and","random query on engine 4 print('\\nNeighbour distances with multiple binary hashes:') print(' ->","engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) #","binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as","# First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS):","as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp","is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in","on engine 4 print('\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count","from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations,","4 print('\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count is %d'","and this permission notice shall be included in # all copies or substantial","vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] =","LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION","of exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 =","hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists","hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations],","results = engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) # Real","with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') #","copy # of this software and associated documentation files (the \"Software\"), to deal","permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2',","# Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query)","i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update","print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists","indexing with multiple binary hashes...') t0 = time.time() hashes = [] for k","rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 =","neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,))","is # furnished to do so, subject to the following conditions: # The","and associated documentation files (the \"Software\"), to deal # in the Software without","print(dists) # Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,","# Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create","# Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists","query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming","x in results] print(dists) # Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM))","of feature space DIM = 100 # Number of data points (dont do","LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, #","child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2],","BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN","= RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of","sublicense, and/or sell # copies of the Software, and to permit persons to","Software is # furnished to do so, subject to the following conditions: #","% (t1-t0)) # Get random query vector query = numpy.random.randn(DIM) # Do random","Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2","# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR","= 100 # Number of data points (dont do too much because of","CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT","engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) #","OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE","engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random","as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash","for x in results] print(dists) # Real neighbours print('\\nReal neighbour distances:') query =","# Get random query vector query = numpy.random.randn(DIM) # Do random query on","Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100}","permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index","indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2')","i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time()","matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0))","Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors","= time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash","hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance())","sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes","# copies of the Software, and to permit persons to whom the Software","print('\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count is %d' %","range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took","14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash","DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR","multiple binary hashes...') t0 = time.time() hashes = [] for k in range(20):","Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for","-> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2]","-*- # Copyright (c) 2013 <NAME> # Permission is hereby granted, free of","random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i]","this permission notice shall be included in # all copies or substantial portions","count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x","= numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v)","OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy import unittest import","CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple","NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE","Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists =","software and associated documentation files (the \"Software\"), to deal # in the Software","WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT","query = numpy.random.randn(DIM) # Do random query on engine 3 print('\\nNeighbour distances with","permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random","OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN","HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM = 100 #","neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists =","query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...')","conditions: # The above copyright notice and this permission notice shall be included","= [x[2] for x in results] print(dists) # Real neighbours print('\\nReal neighbour distances:')","and to permit persons to whom the Software is # furnished to do","use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the","Do random query on engine 3 print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate","% engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists)","query vector query = numpy.random.randn(DIM) # Do random query on engine 3 print('\\nNeighbour","LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND","DEALINGS IN # THE SOFTWARE. import numpy import scipy import unittest import time","the Software, and to permit persons to whom the Software is # furnished","rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell #","took %f seconds' % (t1-t0)) # Get random query vector query = numpy.random.randn(DIM)","rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm,","= query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10])","FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF","random query vector query = numpy.random.randn(DIM) # Do random query on engine 3","numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print('","merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to","OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING","ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE","THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import","Do random query on engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate","query on engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is","dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming","hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child","too much because of exact search) POINTS = 20000 ########################################################## print('Performing indexing with","lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i","HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists","RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM = 100","whom the Software is # furnished to do so, subject to the following","-> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2]","# Do random query on engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print(' ->","CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH","example2(): # Dimension of feature space DIM = 100 # Number of data","v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f","free of charge, to any person obtaining a copy # of this software","= time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10))","Software. # THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,","PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT","copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software,","import unittest import time from nearpy import Engine from nearpy.distances import CosineDistance from","because of exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0","= 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations","time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) #","print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists =","without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense,","Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for","rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations hash","to deal # in the Software without restriction, including without limitation the rights","to any person obtaining a copy # of this software and associated documentation","permutations = HashPermutations('permut') # Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm',","4 print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query))","is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in","= CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with","= dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 =","########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations","permission notice shall be included in # all copies or substantial portions of","sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations","i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time()","coding: utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is hereby granted,","OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, #","Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash","(c) 2013 <NAME> # Permission is hereby granted, free of charge, to any","THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN","engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix =","HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) #","OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import","index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get","binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} #","# Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add","= HashPermutations('permut') # Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14)","= query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ##########################################################","OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE","time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random query vector query","t0 = time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k,","%f seconds' % (t1-t0)) # Get random query vector query = numpy.random.randn(DIM) #","FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE #","SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES","query = numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour distances with","% engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists)","with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query)","# Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as child","permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as child hash rbp_perm","import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of","dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary hashes...') t0","Software, and to permit persons to whom the Software is # furnished to","engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours print('\\nReal","nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM","# Do random query on engine 3 print('\\nNeighbour distances with HashPermutations:') print(' ->","engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours print('\\nReal","= v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing","from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): #","WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE.","# Dimension of feature space DIM = 100 # Number of data points","the Software. # THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY","[x[2] for x in results] print(dists) # Real neighbours print('\\nReal neighbour distances:') query","= numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds'","matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time()","unittest import time from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes","this software and associated documentation files (the \"Software\"), to deal # in the","= numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v)","########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2","numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1","# THE SOFTWARE. import numpy import scipy import unittest import time from nearpy","time from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections,","matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v","update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0))","shall be included in # all copies or substantial portions of the Software.","OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY,","%d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in results]","distances with multiple binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query))","Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for","granted, free of charge, to any person obtaining a copy # of this","numpy.random.randn(DIM) # Do random query on engine 3 print('\\nNeighbour distances with HashPermutations:') print('","Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as child hash","modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and","ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES","DIM = 100 # Number of data points (dont do too much because","# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,","# Permission is hereby granted, free of charge, to any person obtaining a","print('Indexing took %f seconds' % (t1-t0)) # Get random query vector query =","nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper","= Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM))","query on engine 4 print('\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate","-*- coding: utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is hereby","for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then","IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF","with multiple binary hashes...') t0 = time.time() hashes = [] for k in","publish, distribute, sublicense, and/or sell # copies of the Software, and to permit","%d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in results]","\"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT","child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as","engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix","binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query)","v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took","be included in # all copies or substantial portions of the Software. #","range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took","binary hashes...') t0 = time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d'","OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION","without restriction, including without limitation the rights # to use, copy, modify, merge,","distances with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results =","following conditions: # The above copyright notice and this permission notice shall be","multiple binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results =","search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() #","% engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists)","utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is hereby granted, free","in the Software without restriction, including without limitation the rights # to use,","# Number of data points (dont do too much because of exact search)","time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as","the following conditions: # The above copyright notice and this permission notice shall","scipy import unittest import time from nearpy import Engine from nearpy.distances import CosineDistance","PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS","much because of exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...')","hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) #","copies of the Software, and to permit persons to whom the Software is","Dimension of feature space DIM = 100 # Number of data points (dont","HashPermutations('permut') # Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf","hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First","Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2():","RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations","index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v =","as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM,","hashes...') t0 = time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' %","data points (dont do too much because of exact search) POINTS = 20000","= engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours","CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with","import scipy import unittest import time from nearpy import Engine from nearpy.distances import","Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors","AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR","numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' %","permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) #","Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp","Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine","# Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds'","query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ##########################################################","= HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14)","obtaining a copy # of this software and associated documentation files (the \"Software\"),","= engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours","NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE","HashPermutationMapper def example2(): # Dimension of feature space DIM = 100 # Number","print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists =","MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL","permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2","dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary","and/or sell # copies of the Software, and to permit persons to whom","distances with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results =","on engine 3 print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d'","= engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours","dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing","# Copyright (c) 2013 <NAME> # Permission is hereby granted, free of charge,","engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix =","child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM,","3 print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query))","# in the Software without restriction, including without limitation the rights # to","copies or substantial portions of the Software. # THE SOFTWARE IS PROVIDED \"AS","v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get","v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get","permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some","TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE","meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 =","IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN #","print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations =","# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS","= numpy.random.randn(DIM) # Do random query on engine 3 print('\\nNeighbour distances with HashPermutations:')","vector query = numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour distances","# all copies or substantial portions of the Software. # THE SOFTWARE IS","hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child","any person obtaining a copy # of this software and associated documentation files","print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash","= numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v)","is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in","in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing","engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random","numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' %","rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm","time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as","Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for","\"Software\"), to deal # in the Software without restriction, including without limitation the","space DIM = 100 # Number of data points (dont do too much","print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results","rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash","results] print(dists) # Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists =","= [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine","# Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child","seconds' % (t1-t0)) # Get random query vector query = numpy.random.randn(DIM) # Do","copyright notice and this permission notice shall be included in # all copies","with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query)","AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE","IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED,","a copy # of this software and associated documentation files (the \"Software\"), to","deal # in the Software without restriction, including without limitation the rights #","with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut') #","count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x","matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0))","hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations","# -*- coding: utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is","(t1-t0)) # Get random query vector query = numpy.random.randn(DIM) # Do random query","numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) #","import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def","lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i","dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0","print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,))","RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) #","distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists)","engine 3 print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d' %","AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER #","(the \"Software\"), to deal # in the Software without restriction, including without limitation","IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR","distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists =","Copyright (c) 2013 <NAME> # Permission is hereby granted, free of charge, to","distribute, sublicense, and/or sell # copies of the Software, and to permit persons","v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f","in results] print(dists) # Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists","charge, to any person obtaining a copy # of this software and associated","WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO","dists = [x[2] for x in results] print(dists) # Real neighbours print('\\nReal neighbour","# Do random query on engine 4 print('\\nNeighbour distances with multiple binary hashes:')","feature space DIM = 100 # Number of data points (dont do too","HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists","= CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing","WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO","-> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2]","WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED","KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF","to whom the Software is # furnished to do so, subject to the","limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or","random query on engine 3 print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate count","from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space","COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER","engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix","k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM,","% k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First","import time from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import","########################################################## print('\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes = []","in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes,","= Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM))","import numpy import scipy import unittest import time from nearpy import Engine from","engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix","= v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) #","of the Software. # THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF","query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists)","print('\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes = [] for","random query vector query = numpy.random.randn(DIM) # Do random query on engine 4","IN # THE SOFTWARE. import numpy import scipy import unittest import time from","THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR","v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index()","2013 <NAME> # Permission is hereby granted, free of charge, to any person","# furnished to do so, subject to the following conditions: # The above","some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM)","permit persons to whom the Software is # furnished to do so, subject","child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of","THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy","Permission is hereby granted, free of charge, to any person obtaining a copy","neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists","THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR","IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT","dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary hashes...') t0 =","EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,","Software without restriction, including without limitation the rights # to use, copy, modify,","print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists =","print(dists) # Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query)","furnished to do so, subject to the following conditions: # The above copyright","with multiple binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results","substantial portions of the Software. # THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT","count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x","Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for","portions of the Software. # THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY","neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists =","= numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour distances with HashPermutationMapper:')","SOFTWARE. import numpy import scipy import unittest import time from nearpy import Engine","query on engine 3 print('\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is","Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' %","# The above copyright notice and this permission notice shall be included in","# of this software and associated documentation files (the \"Software\"), to deal #","OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR","or substantial portions of the Software. # THE SOFTWARE IS PROVIDED \"AS IS\",","query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10])","= sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary hashes...') t0 = time.time()","CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE","meta-hash permutations = HashPermutations('permut') # Create binary hash as child hash rbp_perm =","sell # copies of the Software, and to permit persons to whom the","results = engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) # Real","lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i","hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add","engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f","print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 =","hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create","Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for","SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy","100 # Number of data points (dont do too much because of exact","= sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create","as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm =","restriction, including without limitation the rights # to use, copy, modify, merge, publish,","permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) #","= v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) #","FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS","t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary","t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create binary","of data points (dont do too much because of exact search) POINTS =","BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR","<NAME> # Permission is hereby granted, free of charge, to any person obtaining","def example2(): # Dimension of feature space DIM = 100 # Number of","numpy import scipy import unittest import time from nearpy import Engine from nearpy.distances","in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted","FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE","OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT","PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING","HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create","= RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2)","Real neighbours print('\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists","files (the \"Software\"), to deal # in the Software without restriction, including without","# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS","do too much because of exact search) POINTS = 20000 ########################################################## print('Performing indexing","engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) #","for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 =","engine 4 print('\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count is","the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell","CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature","engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d' %","of the Software, and to permit persons to whom the Software is #","numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 =","# Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random","First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v","so, subject to the following conditions: # The above copyright notice and this","The above copyright notice and this permission notice shall be included in #","IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR","OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy import unittest","10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some","= numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds'","print(dists[:10]) ########################################################## print('\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes =","on engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d'","import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM =","# Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine","= {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf)","indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut')","numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour distances with multiple binary","[] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps","OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER","HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN","including without limitation the rights # to use, copy, modify, merge, publish, distribute,","distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in","query vector query = numpy.random.randn(DIM) # Do random query on engine 4 print('\\nNeighbour","permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First","in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing","included in # all copies or substantial portions of the Software. # THE","# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER","range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index","nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension","= Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM))","engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours print('\\nReal","associated documentation files (the \"Software\"), to deal # in the Software without restriction,","USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy import","for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps =","hereby granted, free of charge, to any person obtaining a copy # of","of this software and associated documentation files (the \"Software\"), to deal # in","OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS","{'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) #","notice shall be included in # all copies or substantial portions of the","(dont do too much because of exact search) POINTS = 20000 ########################################################## print('Performing","engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix =","t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random query","vector query = numpy.random.randn(DIM) # Do random query on engine 3 print('\\nNeighbour distances","of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) #","NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY","dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\nPerforming indexing with HashPermutationMapper...') t0 = time.time()","all copies or substantial portions of the Software. # THE SOFTWARE IS PROVIDED","to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of","exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time()","14) # Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create","the Software is # furnished to do so, subject to the following conditions:","Get random query vector query = numpy.random.randn(DIM) # Do random query on engine","do so, subject to the following conditions: # The above copyright notice and","random query on engine 4 print('\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count"],"string":"[\n \"TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\",\n \"k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index\",\n \"EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\",\n \"= numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour distances with multiple\",\n \"the Software without restriction, including without limitation the rights # to use, copy,\",\n \"ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN\",\n \"person obtaining a copy # of this software and associated documentation files (the\",\n \"of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance())\",\n \"Number of data points (dont do too much because of exact search) POINTS\",\n \"A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR\",\n \"SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #\",\n \"range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance())\",\n \"THE SOFTWARE. import numpy import scipy import unittest import time from nearpy import\",\n \"to the following conditions: # The above copyright notice and this permission notice\",\n \"# Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random\",\n \"# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies\",\n \"= time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random query vector\",\n \"20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash\",\n \"# Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random\",\n \"above copyright notice and this permission notice shall be included in # all\",\n \"to do so, subject to the following conditions: # The above copyright notice\",\n \"dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() #\",\n \"numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1\",\n \"hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index\",\n \"results = engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) # Real\",\n \"in # all copies or substantial portions of the Software. # THE SOFTWARE\",\n \"%d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in results]\",\n \"POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create\",\n \"is hereby granted, free of charge, to any person obtaining a copy #\",\n \"HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create\",\n \"# Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf =\",\n \"print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results\",\n \"persons to whom the Software is # furnished to do so, subject to\",\n \"= time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash\",\n \"= numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1\",\n \"INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A\",\n \"# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\",\n \"rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some\",\n \"OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\",\n \"for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 =\",\n \"documentation files (the \\\"Software\\\"), to deal # in the Software without restriction, including\",\n \"Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors\",\n \"= dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary hashes...')\",\n \"to permit persons to whom the Software is # furnished to do so,\",\n \"ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\",\n \"points (dont do too much because of exact search) POINTS = 20000 ##########################################################\",\n \"Do random query on engine 4 print('\\\\nNeighbour distances with multiple binary hashes:') print('\",\n \"subject to the following conditions: # The above copyright notice and this permission\",\n \"notice and this permission notice shall be included in # all copies or\",\n \"of charge, to any person obtaining a copy # of this software and\",\n \"random query on engine 4 print('\\\\nNeighbour distances with multiple binary hashes:') print(' ->\",\n \"engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) #\",\n \"binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as\",\n \"# First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS):\",\n \"as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp\",\n \"is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in\",\n \"on engine 4 print('\\\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count\",\n \"from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations,\",\n \"4 print('\\\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count is %d'\",\n \"and this permission notice shall be included in # all copies or substantial\",\n \"vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] =\",\n \"LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION\",\n \"of exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 =\",\n \"hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists\",\n \"hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations],\",\n \"results = engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) # Real\",\n \"with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') #\",\n \"copy # of this software and associated documentation files (the \\\"Software\\\"), to deal\",\n \"permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2',\",\n \"# Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query)\",\n \"i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update\",\n \"print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists\",\n \"indexing with multiple binary hashes...') t0 = time.time() hashes = [] for k\",\n \"rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 =\",\n \"neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,))\",\n \"is # furnished to do so, subject to the following conditions: # The\",\n \"and associated documentation files (the \\\"Software\\\"), to deal # in the Software without\",\n \"print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,\",\n \"# Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create\",\n \"# Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists\",\n \"query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming\",\n \"x in results] print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM))\",\n \"of feature space DIM = 100 # Number of data points (dont do\",\n \"LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, #\",\n \"child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2],\",\n \"BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN\",\n \"= RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of\",\n \"sublicense, and/or sell # copies of the Software, and to permit persons to\",\n \"Software is # furnished to do so, subject to the following conditions: #\",\n \"% (t1-t0)) # Get random query vector query = numpy.random.randn(DIM) # Do random\",\n \"Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2\",\n \"# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\",\n \"= 100 # Number of data points (dont do too much because of\",\n \"CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT\",\n \"engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) #\",\n \"OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE\",\n \"engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random\",\n \"as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash\",\n \"for x in results] print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query =\",\n \"# Get random query vector query = numpy.random.randn(DIM) # Do random query on\",\n \"Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100}\",\n \"permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index\",\n \"indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2')\",\n \"i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time()\",\n \"matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0))\",\n \"Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors\",\n \"= time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash\",\n \"hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance())\",\n \"sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes\",\n \"# copies of the Software, and to permit persons to whom the Software\",\n \"print('\\\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count is %d' %\",\n \"range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took\",\n \"14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash\",\n \"DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\",\n \"multiple binary hashes...') t0 = time.time() hashes = [] for k in range(20):\",\n \"Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for\",\n \"-> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2]\",\n \"-*- # Copyright (c) 2013 <NAME> # Permission is hereby granted, free of\",\n \"random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i]\",\n \"this permission notice shall be included in # all copies or substantial portions\",\n \"count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x\",\n \"= numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v)\",\n \"OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy import unittest import\",\n \"CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple\",\n \"NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE\",\n \"Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists =\",\n \"software and associated documentation files (the \\\"Software\\\"), to deal # in the Software\",\n \"WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT\",\n \"query = numpy.random.randn(DIM) # Do random query on engine 3 print('\\\\nNeighbour distances with\",\n \"permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random\",\n \"OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\",\n \"HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM = 100 #\",\n \"neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists =\",\n \"query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...')\",\n \"conditions: # The above copyright notice and this permission notice shall be included\",\n \"= [x[2] for x in results] print(dists) # Real neighbours print('\\\\nReal neighbour distances:')\",\n \"and to permit persons to whom the Software is # furnished to do\",\n \"use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the\",\n \"Do random query on engine 3 print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate\",\n \"% engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists)\",\n \"query vector query = numpy.random.randn(DIM) # Do random query on engine 3 print('\\\\nNeighbour\",\n \"LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND\",\n \"DEALINGS IN # THE SOFTWARE. import numpy import scipy import unittest import time\",\n \"the Software, and to permit persons to whom the Software is # furnished\",\n \"rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell #\",\n \"took %f seconds' % (t1-t0)) # Get random query vector query = numpy.random.randn(DIM)\",\n \"rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm,\",\n \"= query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10])\",\n \"FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF\",\n \"random query vector query = numpy.random.randn(DIM) # Do random query on engine 3\",\n \"numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print('\",\n \"merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to\",\n \"OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\",\n \"ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\",\n \"THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import\",\n \"Do random query on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate\",\n \"query on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is\",\n \"dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming\",\n \"hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child\",\n \"too much because of exact search) POINTS = 20000 ########################################################## print('Performing indexing with\",\n \"lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i\",\n \"HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists\",\n \"RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM = 100\",\n \"whom the Software is # furnished to do so, subject to the following\",\n \"-> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2]\",\n \"# Do random query on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' ->\",\n \"CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH\",\n \"example2(): # Dimension of feature space DIM = 100 # Number of data\",\n \"v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f\",\n \"free of charge, to any person obtaining a copy # of this software\",\n \"= time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10))\",\n \"Software. # THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND,\",\n \"PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT\",\n \"copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software,\",\n \"import unittest import time from nearpy import Engine from nearpy.distances import CosineDistance from\",\n \"because of exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0\",\n \"= 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations\",\n \"time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) #\",\n \"print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists =\",\n \"without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense,\",\n \"Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for\",\n \"rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations hash\",\n \"to deal # in the Software without restriction, including without limitation the rights\",\n \"to any person obtaining a copy # of this software and associated documentation\",\n \"permutations = HashPermutations('permut') # Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm',\",\n \"4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query))\",\n \"is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in\",\n \"= CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with\",\n \"= dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 =\",\n \"########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations\",\n \"permission notice shall be included in # all copies or substantial portions of\",\n \"sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations\",\n \"i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time()\",\n \"coding: utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is hereby granted,\",\n \"OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, #\",\n \"Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash\",\n \"(c) 2013 <NAME> # Permission is hereby granted, free of charge, to any\",\n \"THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\",\n \"engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix =\",\n \"HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) #\",\n \"OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import\",\n \"index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get\",\n \"binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} #\",\n \"# Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add\",\n \"= HashPermutations('permut') # Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14)\",\n \"= query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ##########################################################\",\n \"OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE\",\n \"time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random query vector query\",\n \"t0 = time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k,\",\n \"%f seconds' % (t1-t0)) # Get random query vector query = numpy.random.randn(DIM) #\",\n \"FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE #\",\n \"SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES\",\n \"query = numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour distances with\",\n \"% engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists)\",\n \"with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query)\",\n \"# Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as child\",\n \"permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as child hash rbp_perm\",\n \"import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of\",\n \"dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary hashes...') t0\",\n \"Software, and to permit persons to whom the Software is # furnished to\",\n \"engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours print('\\\\nReal\",\n \"nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM\",\n \"# Do random query on engine 3 print('\\\\nNeighbour distances with HashPermutations:') print(' ->\",\n \"engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours print('\\\\nReal\",\n \"= v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing\",\n \"from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): #\",\n \"WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE.\",\n \"# Dimension of feature space DIM = 100 # Number of data points\",\n \"the Software. # THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY\",\n \"[x[2] for x in results] print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query\",\n \"= numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds'\",\n \"matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time()\",\n \"unittest import time from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes\",\n \"this software and associated documentation files (the \\\"Software\\\"), to deal # in the\",\n \"= numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v)\",\n \"########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2\",\n \"numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1\",\n \"# THE SOFTWARE. import numpy import scipy import unittest import time from nearpy\",\n \"time from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections,\",\n \"matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v\",\n \"update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0))\",\n \"shall be included in # all copies or substantial portions of the Software.\",\n \"OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY,\",\n \"%d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in results]\",\n \"distances with multiple binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query))\",\n \"Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for\",\n \"granted, free of charge, to any person obtaining a copy # of this\",\n \"numpy.random.randn(DIM) # Do random query on engine 3 print('\\\\nNeighbour distances with HashPermutations:') print('\",\n \"Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as child hash\",\n \"modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and\",\n \"ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\",\n \"DIM = 100 # Number of data points (dont do too much because\",\n \"# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\",\n \"# Permission is hereby granted, free of charge, to any person obtaining a\",\n \"print('Indexing took %f seconds' % (t1-t0)) # Get random query vector query =\",\n \"nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper\",\n \"= Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM))\",\n \"query on engine 4 print('\\\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate\",\n \"-*- coding: utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is hereby\",\n \"for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then\",\n \"IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF\",\n \"with multiple binary hashes...') t0 = time.time() hashes = [] for k in\",\n \"publish, distribute, sublicense, and/or sell # copies of the Software, and to permit\",\n \"%d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for x in results]\",\n \"\\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT\",\n \"child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as\",\n \"engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix\",\n \"binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query)\",\n \"v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took\",\n \"be included in # all copies or substantial portions of the Software. #\",\n \"range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took\",\n \"binary hashes...') t0 = time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d'\",\n \"OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION\",\n \"without restriction, including without limitation the rights # to use, copy, modify, merge,\",\n \"distances with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results =\",\n \"following conditions: # The above copyright notice and this permission notice shall be\",\n \"multiple binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results =\",\n \"search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time() #\",\n \"% engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists)\",\n \"utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is hereby granted, free\",\n \"in the Software without restriction, including without limitation the rights # to use,\",\n \"# Number of data points (dont do too much because of exact search)\",\n \"time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create binary hash as\",\n \"the following conditions: # The above copyright notice and this permission notice shall\",\n \"scipy import unittest import time from nearpy import Engine from nearpy.distances import CosineDistance\",\n \"PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS\",\n \"much because of exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...')\",\n \"hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) #\",\n \"copies of the Software, and to permit persons to whom the Software is\",\n \"Dimension of feature space DIM = 100 # Number of data points (dont\",\n \"HashPermutations('permut') # Create binary hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf\",\n \"hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First\",\n \"Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2():\",\n \"RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations\",\n \"index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v =\",\n \"as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM,\",\n \"hashes...') t0 = time.time() hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' %\",\n \"data points (dont do too much because of exact search) POINTS = 20000\",\n \"= engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours\",\n \"CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with\",\n \"import scipy import unittest import time from nearpy import Engine from nearpy.distances import\",\n \"Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors\",\n \"AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR\",\n \"numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' %\",\n \"permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) #\",\n \"Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp\",\n \"Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine\",\n \"# Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds'\",\n \"query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ##########################################################\",\n \"= HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14)\",\n \"obtaining a copy # of this software and associated documentation files (the \\\"Software\\\"),\",\n \"= engine_rbps.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours\",\n \"NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE\",\n \"HashPermutationMapper def example2(): # Dimension of feature space DIM = 100 # Number\",\n \"print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists =\",\n \"MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL\",\n \"permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2\",\n \"dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary\",\n \"and/or sell # copies of the Software, and to permit persons to whom\",\n \"distances with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results =\",\n \"on engine 3 print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d'\",\n \"= engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours\",\n \"dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing\",\n \"# Copyright (c) 2013 <NAME> # Permission is hereby granted, free of charge,\",\n \"engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix =\",\n \"child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm = Engine(DIM,\",\n \"3 print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query))\",\n \"# in the Software without restriction, including without limitation the rights # to\",\n \"copies or substantial portions of the Software. # THE SOFTWARE IS PROVIDED \\\"AS\",\n \"v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get\",\n \"v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get\",\n \"permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some\",\n \"TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE\",\n \"meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child hash rbp_perm2 =\",\n \"IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN #\",\n \"print('Performing indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations =\",\n \"# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS\",\n \"= numpy.random.randn(DIM) # Do random query on engine 3 print('\\\\nNeighbour distances with HashPermutations:')\",\n \"vector query = numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour distances\",\n \"# all copies or substantial portions of the Software. # THE SOFTWARE IS\",\n \"hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child\",\n \"any person obtaining a copy # of this software and associated documentation files\",\n \"print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash\",\n \"= numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v)\",\n \"is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x in\",\n \"in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing\",\n \"engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random\",\n \"numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' %\",\n \"rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm\",\n \"time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as\",\n \"Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for\",\n \"\\\"Software\\\"), to deal # in the Software without restriction, including without limitation the\",\n \"space DIM = 100 # Number of data points (dont do too much\",\n \"print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results\",\n \"rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash\",\n \"results] print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists =\",\n \"= [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine\",\n \"# Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary hash as child\",\n \"seconds' % (t1-t0)) # Get random query vector query = numpy.random.randn(DIM) # Do\",\n \"copyright notice and this permission notice shall be included in # all copies\",\n \"with HashPermutationMapper:') print(' -> Candidate count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query)\",\n \"AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE\",\n \"IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED,\",\n \"a copy # of this software and associated documentation files (the \\\"Software\\\"), to\",\n \"deal # in the Software without restriction, including without limitation the rights #\",\n \"with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut') #\",\n \"count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x\",\n \"matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0))\",\n \"hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations\",\n \"# -*- coding: utf-8 -*- # Copyright (c) 2013 <NAME> # Permission is\",\n \"(t1-t0)) # Get random query vector query = numpy.random.randn(DIM) # Do random query\",\n \"numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) #\",\n \"import Engine from nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def\",\n \"lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i\",\n \"dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0\",\n \"print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,))\",\n \"RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) #\",\n \"distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists)\",\n \"engine 3 print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is %d' %\",\n \"AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER #\",\n \"(the \\\"Software\\\"), to deal # in the Software without restriction, including without limitation\",\n \"IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR\",\n \"distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists =\",\n \"Copyright (c) 2013 <NAME> # Permission is hereby granted, free of charge, to\",\n \"distribute, sublicense, and/or sell # copies of the Software, and to permit persons\",\n \"v = numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f\",\n \"in results] print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists\",\n \"charge, to any person obtaining a copy # of this software and associated\",\n \"WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO\",\n \"dists = [x[2] for x in results] print(dists) # Real neighbours print('\\\\nReal neighbour\",\n \"# Do random query on engine 4 print('\\\\nNeighbour distances with multiple binary hashes:')\",\n \"feature space DIM = 100 # Number of data points (dont do too\",\n \"HashPermutations:') print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists\",\n \"= CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing\",\n \"WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO\",\n \"-> Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2]\",\n \"WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED\",\n \"KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\",\n \"to whom the Software is # furnished to do so, subject to the\",\n \"limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or\",\n \"random query on engine 3 print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate count\",\n \"from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space\",\n \"COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER\",\n \"engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix\",\n \"k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM,\",\n \"% k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First\",\n \"import time from nearpy import Engine from nearpy.distances import CosineDistance from nearpy.hashes import\",\n \"########################################################## print('\\\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes = []\",\n \"in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes,\",\n \"= Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM))\",\n \"import numpy import scipy import unittest import time from nearpy import Engine from\",\n \"engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix\",\n \"= v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) #\",\n \"of the Software. # THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF\",\n \"query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists = sorted(dists)\",\n \"print('\\\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes = [] for\",\n \"random query vector query = numpy.random.randn(DIM) # Do random query on engine 4\",\n \"IN # THE SOFTWARE. import numpy import scipy import unittest import time from\",\n \"THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR\",\n \"v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index()\",\n \"2013 <NAME> # Permission is hereby granted, free of charge, to any person\",\n \"# furnished to do so, subject to the following conditions: # The above\",\n \"some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v = numpy.random.randn(DIM)\",\n \"permit persons to whom the Software is # furnished to do so, subject\",\n \"child hash rbp_perm2 = RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of\",\n \"THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy\",\n \"Permission is hereby granted, free of charge, to any person obtaining a copy\",\n \"neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists = dists.reshape((-1,)) dists\",\n \"THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\",\n \"IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT\",\n \"dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary hashes...') t0 =\",\n \"EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\",\n \"Software without restriction, including without limitation the rights # to use, copy, modify,\",\n \"print(' -> Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists =\",\n \"print(dists) # Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query)\",\n \"furnished to do so, subject to the following conditions: # The above copyright\",\n \"with multiple binary hashes:') print(' -> Candidate count is %d' % engine_rbps.candidate_count(query)) results\",\n \"substantial portions of the Software. # THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT\",\n \"count is %d' % engine_perm2.candidate_count(query)) results = engine_perm2.neighbours(query) dists = [x[2] for x\",\n \"Candidate count is %d' % engine_rbps.candidate_count(query)) results = engine_rbps.neighbours(query) dists = [x[2] for\",\n \"portions of the Software. # THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY\",\n \"neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists =\",\n \"= numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:')\",\n \"SOFTWARE. import numpy import scipy import unittest import time from nearpy import Engine\",\n \"query on engine 3 print('\\\\nNeighbour distances with HashPermutations:') print(' -> Candidate count is\",\n \"Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' %\",\n \"# The above copyright notice and this permission notice shall be included in\",\n \"# of this software and associated documentation files (the \\\"Software\\\"), to deal #\",\n \"OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR\",\n \"or substantial portions of the Software. # THE SOFTWARE IS PROVIDED \\\"AS IS\\\",\",\n \"query = query.reshape((DIM)) dists = CosineDistance().distance(matrix,query) dists = dists.reshape((-1,)) dists = sorted(dists) print(dists[:10])\",\n \"= sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary hashes...') t0 = time.time()\",\n \"CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE\",\n \"meta-hash permutations = HashPermutations('permut') # Create binary hash as child hash rbp_perm =\",\n \"sell # copies of the Software, and to permit persons to whom the\",\n \"results = engine_perm2.neighbours(query) dists = [x[2] for x in results] print(dists) # Real\",\n \"lshashes=hashes, distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i\",\n \"hash as child hash rbp_perm = RandomBinaryProjections('rbp_perm', 14) rbp_conf = {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add\",\n \"engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f\",\n \"print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 =\",\n \"hashes = [] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create\",\n \"Candidate count is %d' % engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for\",\n \"SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy\",\n \"100 # Number of data points (dont do too much because of exact\",\n \"= sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time() # Create\",\n \"as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) # Create engine engine_perm =\",\n \"restriction, including without limitation the rights # to use, copy, modify, merge, publish,\",\n \"permuted index permutations.build_permuted_index() t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) #\",\n \"= v engine_perm2.store_vector(v) t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) #\",\n \"FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS\",\n \"t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create binary\",\n \"t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut') # Create binary\",\n \"of data points (dont do too much because of exact search) POINTS =\",\n \"BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR\",\n \"<NAME> # Permission is hereby granted, free of charge, to any person obtaining\",\n \"def example2(): # Dimension of feature space DIM = 100 # Number of\",\n \"numpy import scipy import unittest import time from nearpy import Engine from nearpy.distances\",\n \"in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted\",\n \"FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE\",\n \"OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT\",\n \"PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING\",\n \"HashPermutationMapper...') t0 = time.time() # Create permutations meta-hash permutations2 = HashPermutationMapper('permut2') # Create\",\n \"= RandomBinaryProjections('rbp_perm2', 14) # Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2)\",\n \"Real neighbours print('\\\\nReal neighbour distances:') query = query.reshape((DIM)) dists = CosineDistance().distance(matrix, query) dists\",\n \"files (the \\\"Software\\\"), to deal # in the Software without restriction, including without\",\n \"# THE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\",\n \"do too much because of exact search) POINTS = 20000 ########################################################## print('Performing indexing\",\n \"engine_perm.candidate_count(query)) results = engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) #\",\n \"for i in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 =\",\n \"engine 4 print('\\\\nNeighbour distances with multiple binary hashes:') print(' -> Candidate count is\",\n \"the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\",\n \"CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature\",\n \"engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d' %\",\n \"of the Software, and to permit persons to whom the Software is #\",\n \"numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index permutations.build_permuted_index() t1 =\",\n \"# Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First index some random\",\n \"First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in range(POINTS): v\",\n \"so, subject to the following conditions: # The above copyright notice and this\",\n \"The above copyright notice and this permission notice shall be included in #\",\n \"IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR\",\n \"OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy import unittest\",\n \"10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index some\",\n \"= numpy.random.randn(DIM) matrix[i] = v engine_rbps.store_vector(v) t1 = time.time() print('Indexing took %f seconds'\",\n \"print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with multiple binary hashes...') t0 = time.time() hashes =\",\n \"on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count is %d'\",\n \"import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension of feature space DIM =\",\n \"# Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine\",\n \"= {'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf)\",\n \"indexing with HashPermutations...') t0 = time.time() # Create permutations meta-hash permutations = HashPermutations('permut')\",\n \"numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour distances with multiple binary\",\n \"[] for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps\",\n \"OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\",\n \"HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN\",\n \"including without limitation the rights # to use, copy, modify, merge, publish, distribute,\",\n \"distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM)) for i in\",\n \"query vector query = numpy.random.randn(DIM) # Do random query on engine 4 print('\\\\nNeighbour\",\n \"permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) # First\",\n \"in range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm2.store_vector(v) t1 = time.time() print('Indexing\",\n \"included in # all copies or substantial portions of the Software. # THE\",\n \"# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\",\n \"range(POINTS): v = numpy.random.randn(DIM) matrix[i] = v engine_perm.store_vector(v) # Then update permuted index\",\n \"nearpy.distances import CosineDistance from nearpy.hashes import RandomBinaryProjections, HashPermutations, HashPermutationMapper def example2(): # Dimension\",\n \"= Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix = numpy.zeros((POINTS,DIM))\",\n \"engine_perm.neighbours(query) dists = [x[2] for x in results] print(dists) # Real neighbours print('\\\\nReal\",\n \"associated documentation files (the \\\"Software\\\"), to deal # in the Software without restriction,\",\n \"USE OR OTHER DEALINGS IN # THE SOFTWARE. import numpy import scipy import\",\n \"for k in range(20): hashes.append(RandomBinaryProjections('rbp_%d' % k, 10)) # Create engine engine_rbps =\",\n \"hereby granted, free of charge, to any person obtaining a copy # of\",\n \"of this software and associated documentation files (the \\\"Software\\\"), to deal # in\",\n \"OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\",\n \"{'num_permutation':50,'beam_size':10,'num_neighbour':100} # Add rbp as child hash of permutations hash permutations.add_child_hash(rbp_perm, rbp_conf) #\",\n \"notice shall be included in # all copies or substantial portions of the\",\n \"(dont do too much because of exact search) POINTS = 20000 ########################################################## print('Performing\",\n \"engine_perm = Engine(DIM, lshashes=[permutations], distance=CosineDistance()) # First index some random vectors matrix =\",\n \"t1 = time.time() print('Indexing took %f seconds' % (t1-t0)) # Get random query\",\n \"vector query = numpy.random.randn(DIM) # Do random query on engine 3 print('\\\\nNeighbour distances\",\n \"of permutations hash permutations2.add_child_hash(rbp_perm2) # Create engine engine_perm2 = Engine(DIM, lshashes=[permutations2], distance=CosineDistance()) #\",\n \"NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\",\n \"dists.reshape((-1,)) dists = sorted(dists) print(dists[:10]) ########################################################## print('\\\\nPerforming indexing with HashPermutationMapper...') t0 = time.time()\",\n \"all copies or substantial portions of the Software. # THE SOFTWARE IS PROVIDED\",\n \"to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of\",\n \"exact search) POINTS = 20000 ########################################################## print('Performing indexing with HashPermutations...') t0 = time.time()\",\n \"14) # Add rbp as child hash of permutations hash permutations2.add_child_hash(rbp_perm2) # Create\",\n \"the Software is # furnished to do so, subject to the following conditions:\",\n \"Get random query vector query = numpy.random.randn(DIM) # Do random query on engine\",\n \"do so, subject to the following conditions: # The above copyright notice and\",\n \"random query on engine 4 print('\\\\nNeighbour distances with HashPermutationMapper:') print(' -> Candidate count\"\n]","isConversational":false}}},{"rowIdx":290,"cells":{"ngram":{"kind":"list like","value":["print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys()","discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0","1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky: i=str(i) if i ==","p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading =","else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self):","# Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import","traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__)","print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def","# 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class","Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン","Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import r TOKEN","# discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\"","ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q","# クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command)","super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception:","print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency *","os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] #","INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): #","__init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in","cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self):","<カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping","import traceback # エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN']","p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\")","__name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping bot.run(TOKEN) # Botのトークン","ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency","if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\"0\": count+=1 if","def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def","<コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) #","{prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand())","p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\")","on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World","else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand):","__init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self):","import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS =","= \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if","get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__':","INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() #","return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot","] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。","i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in","Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID","in ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for","for q in smsd: q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True:","= \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help","def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog","count=0 for i in ky: i=str(i) if i == global_ch: count+=1 if count>0:","# エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix =","commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import","async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------')","await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky: i=str(i)","\"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\"","in smsd: q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else:","discord.ext import commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import","import commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os","smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\")","global_ch=\"gloch\" count=0 for i in ky: i=str(i) if i == global_ch: count+=1 if","INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) #","Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import r TOKEN =","{prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g.","count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\"0\": count+=1 if count>0:","count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\")","print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__()","self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky: i=str(i) if","\"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\")","def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ ==","ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect()","os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd',","if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if","= \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help","for i in ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch)","\"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__","else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\"","self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明:","i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q)","# MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。","import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス","print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for","try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前","= [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。","print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"]","# ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms'))","smsd: q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\")","== global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if","= os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ]","* 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky: i=str(i) if i","MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for","def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello","self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。","#MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping bot.run(TOKEN)","(f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot =","help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try:","q in smsd: q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\")","# エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント","except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) #","if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\"","= os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat',","q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else:","p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category","i in ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0","# Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) #","print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i","エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async","count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\"0\": count+=1","else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading","!!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky:","# スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog)","'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): #","print(\"正常起動\") else: print(\"異常発生\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category =","count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True:","スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except","q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else:","print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") class","if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky) else: p=conn.sadd(global_ch,\"0\") if p==True: print(\"正常起動\") else:","r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [","[ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def","TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval',","print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!')","traceback # エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix","class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] =","import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。","tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord","discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS","読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot):","from discord.ext import commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート","for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def","class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。","self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id)","#プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。","World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in","エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX']","f\"各カテゴリの説明: {prefix}help <カテゴリ名>\\n\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。","MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 #","in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name)","JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\"","super().__init__() self.commands_heading = \"コマンド:\" self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return","if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd:","self.no_category = \"その他\" self.command_attrs[\"help\"] = \"コマンド一覧と簡単な説明を表示\" def get_ending_note(self): return (f\"各コマンドの説明: {prefix}help <コマンド名>\\n\" f\"各カテゴリの説明:","Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import r","ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky: i=str(i) if i == global_ch: count+=1","global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\"0\":","'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix,","クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) #","if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if p==True: print(\"正常起動\") else: print(\"異常発生\") else: print(ky)","conn=r.connect() ky=conn.keys() global_ch=\"gloch\" count=0 for i in ky: i=str(i) if i == global_ch:","prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel'","command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS:","'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self,","'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command):","os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス #","# ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await","# INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc()","count=0 for q in smsd: q=str(q) if q==\"0\": count+=1 if count>0: p=conn.srem(global_ch,\"0\") if","if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping bot.run(TOKEN) #"],"string":"[\n \"print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys()\",\n \"discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0\",\n \"1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i) if i ==\",\n \"p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading =\",\n \"else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self):\",\n \"# Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import\",\n \"traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__)\",\n \"print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def\",\n \"# 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class\",\n \"Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン\",\n \"Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import r TOKEN\",\n \"# discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\"\",\n \"ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q\",\n \"# クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command)\",\n \"super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception:\",\n \"print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency *\",\n \"os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] #\",\n \"INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): #\",\n \"__init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in\",\n \"cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self):\",\n \"<カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping\",\n \"import traceback # エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN']\",\n \"p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\")\",\n \"__name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping bot.run(TOKEN) # Botのトークン\",\n \"ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency\",\n \"if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\\\"0\\\": count+=1 if\",\n \"def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def\",\n \"<コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) #\",\n \"{prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand())\",\n \"p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\")\",\n \"on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World\",\n \"else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand):\",\n \"__init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self):\",\n \"import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS =\",\n \"= \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if\",\n \"get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__':\",\n \"INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() #\",\n \"return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot\",\n \"] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。\",\n \"i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in\",\n \"Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID\",\n \"in ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for\",\n \"for q in smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True:\",\n \"= \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help\",\n \"def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog\",\n \"count=0 for i in ky: i=str(i) if i == global_ch: count+=1 if count>0:\",\n \"# エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix =\",\n \"commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import\",\n \"async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------')\",\n \"await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i)\",\n \"\\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\"\",\n \"in smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else:\",\n \"discord.ext import commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import\",\n \"import commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os\",\n \"smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\")\",\n \"global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i) if i == global_ch: count+=1 if\",\n \"INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) #\",\n \"Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import r TOKEN =\",\n \"{prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g.\",\n \"count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0:\",\n \"count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\")\",\n \"print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__()\",\n \"self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i) if\",\n \"\\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\")\",\n \"def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ ==\",\n \"ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect()\",\n \"os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd',\",\n \"if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if\",\n \"= \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help\",\n \"for i in ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch)\",\n \"\\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__\",\n \"else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\"\",\n \"self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明:\",\n \"i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q)\",\n \"# MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。\",\n \"import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス\",\n \"print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for\",\n \"try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前\",\n \"= [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。\",\n \"print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"]\",\n \"# ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms'))\",\n \"smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\")\",\n \"== global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if\",\n \"= os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ]\",\n \"* 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i) if i\",\n \"MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for\",\n \"def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello\",\n \"self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。\",\n \"#MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping bot.run(TOKEN)\",\n \"(f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot =\",\n \"help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try:\",\n \"q in smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\")\",\n \"# エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント\",\n \"except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) #\",\n \"if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\"\",\n \"= os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat',\",\n \"q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else:\",\n \"p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category\",\n \"i in ky: i=str(i) if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0\",\n \"# Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) #\",\n \"print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i\",\n \"エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async\",\n \"count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\\\"0\\\": count+=1\",\n \"else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading\",\n \"!!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky:\",\n \"# スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog)\",\n \"'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): #\",\n \"print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category =\",\n \"count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True:\",\n \"スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except\",\n \"q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else:\",\n \"print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") class\",\n \"if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky) else: p=conn.sadd(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else:\",\n \"r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [\",\n \"[ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def\",\n \"TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval',\",\n \"print(self.user.name) # ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!')\",\n \"traceback # エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix\",\n \"class JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] =\",\n \"import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。\",\n \"tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord\",\n \"discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS\",\n \"読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot):\",\n \"from discord.ext import commands, tasks # Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート\",\n \"for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def\",\n \"class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。\",\n \"self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name) # ボットの名前 print(self.user.id)\",\n \"#プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。\",\n \"World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in\",\n \"エラー表示のためにインポート import os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX']\",\n \"f\\\"各カテゴリの説明: {prefix}help <カテゴリ名>\\\\n\\\") #MyBotのインスタンス化及び起動処理。 if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。\",\n \"MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 #\",\n \"in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc() # Botの準備完了時に呼び出されるイベント async def on_ready(self): print(self.user.name)\",\n \"JapaneseHelpCommand(commands.DefaultHelpCommand): def __init__(self): super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\"\",\n \"super().__init__() self.commands_heading = \\\"コマンド:\\\" self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return\",\n \"if i == global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd:\",\n \"self.no_category = \\\"その他\\\" self.command_attrs[\\\"help\\\"] = \\\"コマンド一覧と簡単な説明を表示\\\" def get_ending_note(self): return (f\\\"各コマンドの説明: {prefix}help <コマンド名>\\\\n\\\" f\\\"各カテゴリの説明:\",\n \"Bot Commands Frameworkをインポート import traceback # エラー表示のためにインポート import os import discord import r\",\n \"ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i) if i == global_ch: count+=1\",\n \"global_ch: count+=1 if count>0: smsd=conn.smembers(global_ch) count=0 for q in smsd: q=str(q) if q==\\\"0\\\":\",\n \"'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix,\",\n \"クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) #\",\n \"if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if p==True: print(\\\"正常起動\\\") else: print(\\\"異常発生\\\") else: print(ky)\",\n \"conn=r.connect() ky=conn.keys() global_ch=\\\"gloch\\\" count=0 for i in ky: i=str(i) if i == global_ch:\",\n \"prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス # 読み込むコグの名前を格納しておく。 INITIAL_EXTENSIONS = [ 'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel'\",\n \"command_prefix, help_command): # スーパークラスのコンストラクタに値を渡して実行。 super().__init__(command_prefix,help_command) # INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS:\",\n \"'cogs.eval', 'cogs.glchat', 'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self,\",\n \"'cogs.gladd', 'cogs.gldel' ] # クラスの定義。ClientのサブクラスであるBotクラスを継承。 class MyBot(commands.Bot): # MyBotのコンストラクタ。 def __init__(self, command_prefix, help_command):\",\n \"os import discord import r TOKEN = os.environ['DISCORD_BOT_TOKEN'] prefix = os.environ['DISCORD_BOT_PREFIX'] #プレフィックス #\",\n \"# ボットの名前 print(self.user.id) # ボットのID print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await\",\n \"# INITIAL_COGSに格納されている名前から、コグを読み込む。 # エラーが発生した場合は、エラー内容を表示。 for cog in INITIAL_EXTENSIONS: try: self.load_extension(cog) except Exception: traceback.print_exc()\",\n \"count=0 for q in smsd: q=str(q) if q==\\\"0\\\": count+=1 if count>0: p=conn.srem(global_ch,\\\"0\\\") if\",\n \"if __name__ == '__main__': bot = MyBot(command_prefix=prefix,help_command=JapaneseHelpCommand()) # command_prefixはコマンドの最初の文字として使うもの。 e.g. !ping bot.run(TOKEN) #\"\n]","isConversational":false}}},{"rowIdx":291,"cells":{"ngram":{"kind":"list like","value":["# The package used for creating and manipulating HDF5 files: import h5py #","# Import packages # Ensure that this code works on both python 2","files: # finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy","method to determine the types of spectral responses present in the # data.","px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of components') # Visualize","factors (matrices) W and H, given a matrix V, as shown below #","px except ImportError: print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy')","Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force","of the page) and use your own data instead. # When using your","# 1. Singular Value Decomposition (SVD) # ===================================== # # SVD is an","Notice that we are working with a complex valued dataset. Passing the complex","# (ie., assignment of each spectra as belonging to the k<sup>th</sup> set) such","the non-negative portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random',","a quick and easy method to determine the types of spectral responses present","Data # ======== # # In this example, we will work on a","the concatenation of the real and imaginary # components. So, the eigenvectors would","source h5 file including all relevant links to the source dataset and other","clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels","# finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not","unmixing of spectral # data. It only works on data with positive real","(x, y) have been collapsed to one, we need to reshape the abundance","been collapsed to one, we need to reshape the abundance maps: abun_maps =","with pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils","source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute()","Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) #####################################################################################","# .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be","= np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5))","np # The package used for creating and manipulating HDF5 files: import h5py","In this notebook we load some spectral data, and perform basic data analysis,","Passing the complex values as is to SVD would result in # complex","decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the","data. It is not a decomposition method, but a basic clustering method. The","from sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\",","(SVD) # ===================================== # # SVD is an eigenvector decomposition that is defined","Furthermore, while it is not discussed in this example, pycroscopy also writes back","KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: =======================","eigenvectors / endmembers as well as abundance maps. Complex valued abundance maps are","result in # complex valued eigenvectors / endmembers as well as abundance maps.","# After SVD, the real-valued eigenvectors would need to be treated as the","other things \"\"\" # Import packages # Ensure that this code works on","results back into the same dataset among other things \"\"\" # Import packages","* Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN","# =========================================== # # NMF, or non-negative matrix factorization, is a method that","\"-m\", \"pip\", \"install\", package]) # Package for downloading online files: # finally import","would need to restructure the data such that it is real-valued only. #","h5_svd_group['S'] # Since the two spatial dimensions (x, y) have been collapsed to","Since the two spatial dimensions (x, y) have been collapsed to one, we","# For illustrative purposes, we will only take the amplitude component of the","package]) # Package for downloading online files: # finally import pycroscopy: try: import","non-negative datasets. # For illustrative purposes, we will only take the amplitude component","Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative matrix factorization,","and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and","V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD","the data into. The algorithm proceeds to find the optimal labeling # (ie.,","matplotlib.pyplot as plt # for downloading files: import wget import os # multivariate","importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number","(matrices) W and H, given a matrix V, as shown below # #","two dimensional matrix. # # We will be using an data file available","amplitude component of the spectral data num_comps = 4 # get the non-negative","k<sup>th</sup> set) such that the within-cluster # sum of squares is minimized. #","dataset using only the first N (most significant) components. # # SVD results","is # formatted in the same manner of [position x spectra] in a","for quickly # visualizing the major trends in the dataset since the resultant","the spectral data num_comps = 4 # get the non-negative portion of the","Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy**","= 4 # get the non-negative portion of the dataset data_mat = np.abs(h5_main)","= wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------')","dataset, a spectra was collected for each position in a two # dimensional","within-cluster # sum of squares is minimized. # # Set the number of","a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced","care and caution in interpretation. Nonetheless, it is a good method for quickly","analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal Component","(a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== # # SVD","labeling # (ie., assignment of each spectra as belonging to the k<sup>th</sup> set)","to complex-valued datasets, NMF only works on non-negative datasets. # For illustrative purposes,","subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package for","of spectral # data. It only works on data with positive real values.","title_yoffset=0.95) # Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note","the optimal labeling # (ie., assignment of each spectra as belonging to the","Extracting the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec","example, pycroscopy also writes back the results from SVD back to # the","be restructured to get back the complex valued eigenvectors. # # **Pycroscopy handles","handles all these data transformations (both for the source dataset and the eigenvectors)","and python 3 from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric","import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not found. Will","valued abundance maps are not physical. # Thus, one would need to restructure","belonging to the k<sup>th</sup> set) such that the within-cluster # sum of squares","# Notice that we are working with a complex valued dataset. Passing the","Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential","# The Data # ======== # # In this example, we will work","Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the h5_file h5_file.close()","axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the h5_file","are realized through the ability to seamlessly perform these analyses on any imaging","and visualization: import matplotlib.pyplot as plt # for downloading files: import wget import","importance. Furthermore, SVD is also very well suited for data cleaning through #","and easy method to determine the types of spectral responses present in the","x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value","Nonetheless, it is a good method for quickly # visualizing the major trends","try: import pycroscopy as px except ImportError: print('pycroscopy not found. Will install with","dataset and the eigenvectors) # automatically.** In general, pycroscopy handles compound / complex","of variance or importance. Furthermore, SVD is also very well suited for data","compound / complex valued datasets everywhere possible # # Furthermore, while it is","import os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF","your own data, you can skip this cell and provide the path to","the dataset using only the first N (most significant) components. # # SVD","matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used here","# Ensure that this code works on both python 2 and python 3","etc. only accept data that is # formatted in the same manner of","* V - Eigenvectors sorted by variance in descending order # * U","get the non-negative portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps,","python 3 from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation:","# Plotting and visualization: import matplotlib.pyplot as plt # for downloading files: import","you can skip this cell and provide the path to your data using","provide the path to your data using the variable - data_file_path data_file_path =","to be treated as the concatenation of the real and imaginary # components.","Will install with pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz","true capabilities are realized through the ability to seamlessly perform these analyses on","we will only take the amplitude component of the spectral data num_comps =","it is not discussed in this example, pycroscopy also writes back the results","# factors (matrices) W and H, given a matrix V, as shown below","dataset among other things \"\"\" # Import packages # Ensure that this code","in the dataset since the resultant eigenvectors are sorted in descending # order","python 2 and python 3 from __future__ import division, print_function, absolute_import, unicode_literals #","We will be using an data file available on our GitHub project page","the two spatial dimensions (x, y) have been collapsed to one, we need","but a basic clustering method. The user inputs the number of # clusters","px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance","that has been flattened to a two # dimensional matrix in accordance with","in three matrices: # # * V - Eigenvectors sorted by variance in","##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans clustering is a","both python 2 and python 3 from __future__ import division, print_function, absolute_import, unicode_literals","unmixing algorithms, etc. only accept data that is # formatted in the same","# SVD requires care and caution in interpretation. Nonetheless, it is a good","imaging dataset # acquired from advanced atomic force microscopes. In this dataset, a","2 and python 3 from __future__ import division, print_function, absolute_import, unicode_literals # basic","h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # ===========================================","import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package for downloading","dataset # acquired from advanced atomic force microscopes. In this dataset, a spectra","by variance in descending order # * U - corresponding abundance maps #","perform these analyses on any imaging dataset (regardless of origin, size, complexity) and","random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #')","perform basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization","KMeans from sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\",","\"pip\", \"install\", package]) # Package for downloading online files: # finally import pycroscopy:","= px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s","the major trends in the dataset since the resultant eigenvectors are sorted in","good method for quickly # visualizing the major trends in the dataset since","for each position in a two # dimensional grid of spatial locations. Thus,","dimensional dataset that has been flattened to a two # dimensional matrix in","# # In this example, we will work on a **Band Excitation Piezoresponse","pycroscopy handles compound / complex valued datasets everywhere possible # # Furthermore, while","reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9,","h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization","notebook we load some spectral data, and perform basic data analysis, including: ========================================================================================","of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig,","3 from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation: import","* S - Variance or importance of each of these components # #","also writes back the results from SVD back to # the same source","can skip this cell and provide the path to your data using the","= h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols =","= px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering","It operates by approximate determination of # factors (matrices) W and H, given","SVD and k-Means that can be applied to complex-valued datasets, NMF only works","Institute for Functional Imaging of Materials * Center for Nanophase Materials Sciences Oak","also very well suited for data cleaning through # the reconstruction of the","the number of # clusters (sets) to partition the data into. The algorithm","Materials * Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge","for plotting purposes only, it's true capabilities are realized through the ability to","as well as abundance maps. Complex valued abundance maps are not physical. #","be treated as the concatenation of the real and imaginary # components. So,","h5 file including all relevant links to the source dataset and other ancillary","endmembers as well as abundance maps. Complex valued abundance maps are not physical.","absolute_import, unicode_literals # basic numeric computation: import numpy as np # The package","some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting","a matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # #","Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of","**pycroscopy** : Though pycroscopy is mainly used here for plotting purposes only, it's","the amplitude component of the spectral data num_comps = 4 # get the","as plt # for downloading files: import wget import os # multivariate analysis:","# # **Pycroscopy handles all these data transformations (both for the source dataset","= 'temp_um.h5' # download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path","# the reconstruction of the dataset using only the first N (most significant)","as np # The package used for creating and manipulating HDF5 files: import","same source h5 file including all relevant links to the source dataset and","Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In","working with a complex valued dataset. Passing the complex values as is to","of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main)","valued eigenvectors / endmembers as well as abundance maps. Complex valued abundance maps","================================================================= Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of","import KMeans from sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable,","take the amplitude component of the spectral data num_comps = 4 # get","dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u","the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### #","these data transformations (both for the source dataset and the eigenvectors) # automatically.**","import subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package","a good method for quickly # visualizing the major trends in the dataset","h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3.","dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis =","data transformations (both for the source dataset and the eigenvectors) # automatically.** In","= 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition","as the concatenation of the real and imaginary # components. So, the eigenvectors","interpretation of eigenvectors and abundance maps from # SVD requires care and caution","Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials *","SVD. # After SVD, the real-valued eigenvectors would need to be treated as","illustrative purposes, we will only take the amplitude component of the spectral data","(most significant) components. # # SVD results in three matrices: # # *","h5py # Plotting and visualization: import matplotlib.pyplot as plt # for downloading files:","example, we will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging","need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1))","x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== #","to stack the real value followed by the magnitude of the imaginary component","and H, given a matrix V, as shown below # # .. image::","drop of variance with number of components') # Visualize the eigenvectors: _ =","data such that it is real-valued only. # # One solution is to","towards unmixing of spectral # data. It only works on data with positive","a basic clustering method. The user inputs the number of # clusters (sets)","(ie., assignment of each spectra as belonging to the k<sup>th</sup> set) such that","the same source h5 file including all relevant links to the source dataset","import numpy as np # The package used for creating and manipulating HDF5","plt # for downloading files: import wget import os # multivariate analysis: from","that this code works on both python 2 and python 3 from __future__","passing to SVD. # After SVD, the real-valued eigenvectors would need to be","through the ability to seamlessly perform these analyses on any imaging dataset (regardless","writes back the results from SVD back to # the same source h5","px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis - vector","method. The user inputs the number of # clusters (sets) to partition the","order # * U - corresponding abundance maps # * S - Variance","'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset:","Eigenvectors sorted by variance in descending order # * U - corresponding abundance","maps # * S - Variance or importance of each of these components",".. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be applied","datasets. # For illustrative purposes, we will only take the amplitude component of","= h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF)","analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import sys","it is a good method for quickly # visualizing the major trends in","# multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess","available on our GitHub project page by default. You are encouraged # to","only works on non-negative datasets. # For illustrative purposes, we will only take","the real value followed by the magnitude of the imaginary component before passing","# NMF, or non-negative matrix factorization, is a method that is useful towards","\"install\", package]) # Package for downloading online files: # finally import pycroscopy: try:","maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps',","(both for the source dataset and the eigenvectors) # automatically.** In general, pycroscopy","to find the optimal labeling # (ie., assignment of each spectra as belonging","Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda**","our GitHub project page by default. You are encouraged # to download this","the eigenvectors would need to be restructured to get back the complex valued","shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means","NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF","4 # get the non-negative portion of the dataset data_mat = np.abs(h5_main) model","of Materials * Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak","it's true capabilities are realized through the ability to seamlessly perform these analyses","# # Unlike SVD and k-Means that can be applied to complex-valued datasets,","estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix","manner of [position x spectra] in a two dimensional matrix. # # We","install with pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import","num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset: h5_main","instead. # When using your own data, you can skip this cell and","- vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3","complex values as is to SVD would result in # complex valued eigenvectors","we will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset","(num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) #","# **Pycroscopy handles all these data transformations (both for the source dataset and","import matplotlib.pyplot as plt # for downloading files: import wget import os #","using the variable - data_file_path data_file_path = 'temp_um.h5' # download the data file","would result in # complex valued eigenvectors / endmembers as well as abundance","init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component","**Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic","the page) and use your own data instead. # When using your own","found. Will install with pip.') import pip install('pycroscopy') import pycroscopy as px from","# to download this document as a Jupyter Notebook (button at the bottom","below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that","magnitude of the imaginary component before passing to SVD. # After SVD, the","into. The algorithm proceeds to find the optimal labeling # (ie., assignment of","including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis","learning, spectral unmixing algorithms, etc. only accept data that is # formatted in","data num_comps = 4 # get the non-negative portion of the dataset data_mat","the within-cluster # sum of squares is minimized. # # Set the number","for downloading online files: # finally import pycroscopy: try: import pycroscopy as px","variance or importance. Furthermore, SVD is also very well suited for data cleaning","to be restructured to get back the complex valued eigenvectors. # # **Pycroscopy","works on non-negative datasets. # For illustrative purposes, we will only take the","the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting","===================================== # # SVD is an eigenvector decomposition that is defined statistically, and","is to SVD would result in # complex valued eigenvectors / endmembers as","import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data #","matrices: # # * V - Eigenvectors sorted by variance in descending order","the resultant eigenvectors are sorted in descending # order of variance or importance.","SVD is also very well suited for data cleaning through # the reconstruction","is mainly used here for plotting purposes only, it's true capabilities are realized","1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude","title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans","eigenvectors would need to be restructured to get back the complex valued eigenvectors.","a decomposition method, but a basic clustering method. The user inputs the number","import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### #",":], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ====================","label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12)","model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec,","* Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes","unicode_literals # basic numeric computation: import numpy as np # The package used","eigenvectors are sorted in descending # order of variance or importance. Furthermore, SVD","Package for downloading online files: # finally import pycroscopy: try: import pycroscopy as","in # complex valued eigenvectors / endmembers as well as abundance maps. Complex","imaging dataset (regardless of origin, size, complexity) and storing the results back into","Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= *","major trends in the dataset since the resultant eigenvectors are sorted in descending","while it is not discussed in this example, pycroscopy also writes back the","number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label,","general, pycroscopy handles compound / complex valued datasets everywhere possible # # Furthermore,","value followed by the magnitude of the imaginary component before passing to SVD.","= 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp","and perform basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix","accordance with the pycroscopy data format. # # Fortunately, all statistical analysis, machine","file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file =","maps. Complex valued abundance maps are not physical. # Thus, one would need","Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of","all these data transformations (both for the source dataset and the eigenvectors) #","Clustering # ==================== # # KMeans clustering is a quick and easy method","only take the amplitude component of the spectral data num_comps = 4 #","spectral # data. It only works on data with positive real values. It","* Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) *","The algorithm proceeds to find the optimal labeling # (ie., assignment of each","import wget import os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition","basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization *","Thus, one would need to restructure the data such that it is real-valued","of # clusters (sets) to partition the data into. The algorithm proceeds to","method, but a basic clustering method. The user inputs the number of #","h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== # #","is not discussed in this example, pycroscopy also writes back the results from","two # dimensional matrix in accordance with the pycroscopy data format. # #","mainly used here for plotting purposes only, it's true capabilities are realized through","load some spectral data, and perform basic data analysis, including: ======================================================================================== * KMeans","h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis","works on data with positive real values. It operates by approximate determination of","2. KMeans Clustering # ==================== # # KMeans clustering is a quick and","for downloading files: import wget import os # multivariate analysis: from sklearn.cluster import","imaginary component before passing to SVD. # After SVD, the real-valued eigenvectors would","Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In this notebook","squares is minimized. # # Set the number of clusters below num_clusters =","multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import","flattened to a two # dimensional matrix in accordance with the pycroscopy data","the pycroscopy data format. # # Fortunately, all statistical analysis, machine learning, spectral","are sorted in descending # order of variance or importance. Furthermore, SVD is","plotting purposes only, it's true capabilities are realized through the ability to seamlessly","for Functional Imaging of Materials * Center for Nanophase Materials Sciences Oak Ridge","the data such that it is real-valued only. # # One solution is","packages # Ensure that this code works on both python 2 and python","descending # order of variance or importance. Furthermore, SVD is also very well","\"\"\" # Import packages # Ensure that this code works on both python","Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard distribution","# When using your own data, you can skip this cell and provide","valued eigenvectors. # # **Pycroscopy handles all these data transformations (both for the","In this dataset, a spectra was collected for each position in a two","visualization: import matplotlib.pyplot as plt # for downloading files: import wget import os","# # Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc. only","three matrices: # # * V - Eigenvectors sorted by variance in descending","complex valued eigenvectors. # # **Pycroscopy handles all these data transformations (both for","automatically.** In general, pycroscopy handles compound / complex valued datasets everywhere possible #","(sets) to partition the data into. The algorithm proceeds to find the optimal","px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) #####################################################################################","is a method that is useful towards unmixing of spectral # data. It","Unlike SVD and k-Means that can be applied to complex-valued datasets, NMF only","'grid_num_cols') # Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main,","is an eigenvector decomposition that is defined statistically, and therefore typically produces #","y) have been collapsed to one, we need to reshape the abundance maps:","code works on both python 2 and python 3 from __future__ import division,","freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency","main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the","method for quickly # visualizing the major trends in the dataset since the","the eigenvectors) # automatically.** In general, pycroscopy handles compound / complex valued datasets","cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF,","corresponding abundance maps # * S - Variance or importance of each of","realized through the ability to seamlessly perform these analyses on any imaging dataset","solution is to stack the real value followed by the magnitude of the","that the within-cluster # sum of squares is minimized. # # Set the","of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic","portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat)","data cleaning through # the reconstruction of the dataset using only the first","h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x, y) have been","axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close","##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or","all statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept data that","each of these components # # Advantage of pycroscopy: # ------------------------ # Notice","sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package for downloading online","dataset that has been flattened to a two # dimensional matrix in accordance","assignment of each spectra as belonging to the k<sup>th</sup> set) such that the","given a matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png #","datasets everywhere possible # # Furthermore, while it is not discussed in this","For illustrative purposes, we will only take the amplitude component of the spectral","is also very well suited for data cleaning through # the reconstruction of","subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package for downloading online files: # finally","from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path,","the variable - data_file_path data_file_path = 'temp_um.h5' # download the data file from","purposes, we will only take the amplitude component of the spectral data num_comps","a Jupyter Notebook (button at the bottom of the page) and use your","basic clustering method. The user inputs the number of # clusters (sets) to","quick and easy method to determine the types of spectral responses present in","this is a three dimensional dataset that has been flattened to a two","that is defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the","present in the # data. It is not a decomposition method, but a","# Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept","= h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial","data format. # # Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms,","= px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape)","num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize","# ==================== # # KMeans clustering is a quick and easy method to","37831, USA In this notebook we load some spectral data, and perform basic","data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal","Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib","= estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative","produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from","dataset since the resultant eigenvectors are sorted in descending # order of variance","your data using the variable - data_file_path data_file_path = 'temp_um.h5' # download the","and caution in interpretation. Nonetheless, it is a good method for quickly #","ability to seamlessly perform these analyses on any imaging dataset (regardless of origin,","SVD results in three matrices: # # * V - Eigenvectors sorted by","# automatically.** In general, pycroscopy handles compound / complex valued datasets everywhere possible","print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as np # The","/ complex valued datasets everywhere possible # # Furthermore, while it is not","importance of each of these components # # Advantage of pycroscopy: # ------------------------","matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike","only works on data with positive real values. It operates by approximate determination","by the magnitude of the imaginary component before passing to SVD. # After","results in three matrices: # # * V - Eigenvectors sorted by variance","links to the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100)","variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of","is a quick and easy method to determine the types of spectral responses","cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s,","the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis","each position in a two # dimensional grid of spatial locations. Thus, this","statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept data that is","data, and perform basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative","**Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy","# non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from #","finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not found.","# * S - Variance or importance of each of these components #","mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting","(NMF) # =========================================== # # NMF, or non-negative matrix factorization, is a method","such that it is real-valued only. # # One solution is to stack","through # the reconstruction of the dataset using only the first N (most","# for downloading files: import wget import os # multivariate analysis: from sklearn.cluster","downloading files: import wget import os # multivariate analysis: from sklearn.cluster import KMeans","first N (most significant) components. # # SVD results in three matrices: #","of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of","of variance with number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9,","to determine the types of spectral responses present in the # data. It","easy method to determine the types of spectral responses present in the #","cell and provide the path to your data using the variable - data_file_path","this dataset, a spectra was collected for each position in a two #","components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors',","sorted by variance in descending order # * U - corresponding abundance maps","determine the types of spectral responses present in the # data. It is","of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently","decomposition that is defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently,","of pycroscopy: # ------------------------ # Notice that we are working with a complex","Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In this","clustering method. The user inputs the number of # clusters (sets) to partition","any imaging dataset (regardless of origin, size, complexity) and storing the results back","basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a","# Package for downloading online files: # finally import pycroscopy: try: import pycroscopy","Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes. In","origin, size, complexity) and storing the results back into the same dataset among","It is not a decomposition method, but a basic clustering method. The user","# SVD is an eigenvector decomposition that is defined statistically, and therefore typically","model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label,","spectral unmixing algorithms, etc. only accept data that is # formatted in the","own data, you can skip this cell and provide the path to your","an eigenvector decomposition that is defined statistically, and therefore typically produces # non-physical","= h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== #","all relevant links to the source dataset and other ancillary datasets decomposer =","among other things \"\"\" # Import packages # Ensure that this code works","{'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis - vector of frequencies","not discussed in this example, pycroscopy also writes back the results from SVD","image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be applied to","data, you can skip this cell and provide the path to your data","useful towards unmixing of spectral # data. It only works on data with","the # data. It is not a decomposition method, but a basic clustering","Variance or importance of each of these components # # Advantage of pycroscopy:","we are working with a complex valued dataset. Passing the complex values as","values. It operates by approximate determination of # factors (matrices) W and H,","= px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset: h5_main =","statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors","Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) #####################################################################################","(includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is","= px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the","to partition the data into. The algorithm proceeds to find the optimal labeling","as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and","of spatial locations. Thus, this is a three dimensional dataset that has been","of the dataset using only the first N (most significant) components. # #","Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials","same manner of [position x spectra] in a two dimensional matrix. # #","learn) * **pycroscopy** : Though pycroscopy is mainly used here for plotting purposes","h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols","cleaning through # the reconstruction of the dataset using only the first N","is real-valued only. # # One solution is to stack the real value","of spectral responses present in the # data. It is not a decomposition","real values. It operates by approximate determination of # factors (matrices) W and","Furthermore, SVD is also very well suited for data cleaning through # the","pycroscopy also writes back the results from SVD back to # the same","National Laboratory, Oak Ridge TN 37831, USA In this notebook we load some","as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== #","including all relevant links to the source dataset and other ancillary datasets decomposer","method that is useful towards unmixing of spectral # data. It only works","the ability to seamlessly perform these analyses on any imaging dataset (regardless of","num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to","requires care and caution in interpretation. Nonetheless, it is a good method for","title='Note the exponential drop of variance with number of components') # Visualize the","pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils #####################################################################################","are encouraged # to download this document as a Jupyter Notebook (button at","model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0],","datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v =","not physical. # Thus, one would need to restructure the data such that","atomic force microscopes. In this dataset, a spectra was collected for each position","to restructure the data such that it is real-valued only. # # One","a two # dimensional grid of spatial locations. Thus, this is a three","online files: # finally import pycroscopy: try: import pycroscopy as px except ImportError:","for data cleaning through # the reconstruction of the dataset using only the","px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s =","data file available on our GitHub project page by default. You are encouraged","the same manner of [position x spectra] in a two dimensional matrix. #","minimized. # # Set the number of clusters below num_clusters = 4 estimator","the path to your data using the variable - data_file_path data_file_path = 'temp_um.h5'","'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD)","on both python 2 and python 3 from __future__ import division, print_function, absolute_import,","complex valued dataset. Passing the complex values as is to SVD would result","document as a Jupyter Notebook (button at the bottom of the page) and","cluster_utils ##################################################################################### # The Data # ======== # # In this example, we","[position x spectra] in a two dimensional matrix. # # We will be","* U - corresponding abundance maps # * S - Variance or importance","dimensional matrix in accordance with the pycroscopy data format. # # Fortunately, all","= 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== #","only accept data that is # formatted in the same manner of [position","# Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the","KMeans clustering is a quick and easy method to determine the types of","from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import sys def","TN 37831, USA In this notebook we load some spectral data, and perform","real-valued only. # # One solution is to stack the real value followed","The Data # ======== # # In this example, we will work on","other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U']","two # dimensional grid of spatial locations. Thus, this is a three dimensional","# Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False)","y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # #","<gh_stars>0 \"\"\" ================================================================= Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional","download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path,","of origin, size, complexity) and storing the results back into the same dataset","two spatial dimensions (x, y) have been collapsed to one, we need to","# # We will be using an data file available on our GitHub","the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec =","data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file","print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows =","h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:',","NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) #","in accordance with the pycroscopy data format. # # Fortunately, all statistical analysis,","downloading online files: # finally import pycroscopy: try: import pycroscopy as px except","would need to be restructured to get back the complex valued eigenvectors. #","same dataset among other things \"\"\" # Import packages # Ensure that this","= NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_,","used here for plotting purposes only, it's true capabilities are realized through the","is a good method for quickly # visualizing the major trends in the","in a two # dimensional grid of spatial locations. Thus, this is a","collected for each position in a two # dimensional grid of spatial locations.","np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label","one would need to restructure the data such that it is real-valued only.","the real-valued eigenvectors would need to be treated as the concatenation of the","numpy as np # The package used for creating and manipulating HDF5 files:","os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import","pycroscopy data format. # # Fortunately, all statistical analysis, machine learning, spectral unmixing","factorization, is a method that is useful towards unmixing of spectral # data.","h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x, y) have","data. It only works on data with positive real values. It operates by","Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection',","encouraged # to download this document as a Jupyter Notebook (button at the","skip this cell and provide the path to your data using the variable","Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') #","'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label =","spectral responses present in the # data. It is not a decomposition method,","format. # # Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc.","from SVD back to # the same source h5 file including all relevant","determination of # factors (matrices) W and H, given a matrix V, as","pycroscopy is mainly used here for plotting purposes only, it's true capabilities are","files: import wget import os # multivariate analysis: from sklearn.cluster import KMeans from","U - corresponding abundance maps # * S - Variance or importance of","= decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since","# KMeans clustering is a quick and easy method to determine the types","a method that is useful towards unmixing of spectral # data. It only","distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** :","back the complex valued eigenvectors. # # **Pycroscopy handles all these data transformations","# Advantage of pycroscopy: # ------------------------ # Notice that we are working with","this example, we will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)**","Ridge National Laboratory, Oak Ridge TN 37831, USA In this notebook we load","the interpretation of eigenvectors and abundance maps from # SVD requires care and","of each of these components # # Advantage of pycroscopy: # ------------------------ #","- data_file_path data_file_path = 'temp_um.h5' # download the data file from Github: url","to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps,","y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # =====================================","KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### #","source dataset and the eigenvectors) # automatically.** In general, pycroscopy handles compound /","visualizing the major trends in the dataset since the resultant eigenvectors are sorted","in a two dimensional matrix. # # We will be using an data","dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X","package used for creating and manipulating HDF5 files: import h5py # Plotting and",": Though pycroscopy is mainly used here for plotting purposes only, it's true","# basic numeric computation: import numpy as np # The package used for","pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not found. Will install","analysis, machine learning, spectral unmixing algorithms, etc. only accept data that is #","path to your data using the variable - data_file_path data_file_path = 'temp_um.h5' #","the complex values as is to SVD would result in # complex valued","relevant links to the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main,","sum of squares is minimized. # # Set the number of clusters below","since the resultant eigenvectors are sorted in descending # order of variance or","np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis,","data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:')","(regardless of origin, size, complexity) and storing the results back into the same","pycroscopy as px except ImportError: print('pycroscopy not found. Will install with pip.') import","dimensional matrix. # # We will be using an data file available on","======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software","url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents","trends in the dataset since the resultant eigenvectors are sorted in descending #","followed by the magnitude of the imaginary component before passing to SVD. #","decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V']","using only the first N (most significant) components. # # SVD results in","# # SVD results in three matrices: # # * V - Eigenvectors","Imaging of Materials * Center for Nanophase Materials Sciences Oak Ridge National Laboratory,","# dimensional grid of spatial locations. Thus, this is a three dimensional dataset","4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp =","https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be applied to complex-valued","a three dimensional dataset that has been flattened to a two # dimensional","Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative matrix factorization, is","# Thus, one would need to restructure the data such that it is","own data instead. # When using your own data, you can skip this","download this document as a Jupyter Notebook (button at the bottom of the","# Unlike SVD and k-Means that can be applied to complex-valued datasets, NMF","'units': 'V'}) # Extracting the X axis - vector of frequencies h5_spec_vals =","data instead. # When using your own data, you can skip this cell","statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with","N (most significant) components. # # SVD results in three matrices: # #","is to stack the real value followed by the magnitude of the imaginary","pycroscopy: # ------------------------ # Notice that we are working with a complex valued","and abundance maps from # SVD requires care and caution in interpretation. Nonetheless,","pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ========","Decomposition (SVD) # ===================================== # # SVD is an eigenvector decomposition that is","get back the complex valued eigenvectors. # # **Pycroscopy handles all these data","H, given a matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png","on any imaging dataset (regardless of origin, size, complexity) and storing the results","for the source dataset and the eigenvectors) # automatically.** In general, pycroscopy handles","Singular Value Decomposition (SVD) # ===================================== # # SVD is an eigenvector decomposition","the types of spectral responses present in the # data. It is not","that it is real-valued only. # # One solution is to stack the","stack the real value followed by the magnitude of the imaginary component before","some spectral data, and perform basic data analysis, including: ======================================================================================== * KMeans Clustering","basic numeric computation: import numpy as np # The package used for creating","h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] #","axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete","this cell and provide the path to your data using the variable -","* Institute for Functional Imaging of Materials * Center for Nanophase Materials Sciences","operates by approximate determination of # factors (matrices) W and H, given a","# order of variance or importance. Furthermore, SVD is also very well suited","<NAME>, <NAME> * Institute for Functional Imaging of Materials * Center for Nanophase","install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data","and manipulating HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot as","##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== # # SVD is","reconstruction of the dataset using only the first N (most significant) components. #","shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1.","only the first N (most significant) components. # # SVD results in three","significant) components. # # SVD results in three matrices: # # * V","file including all relevant links to the source dataset and other ancillary datasets","-1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the","It only works on data with positive real values. It operates by approximate","fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12)","as belonging to the k<sup>th</sup> set) such that the within-cluster # sum of","therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance","purposes only, it's true capabilities are realized through the ability to seamlessly perform","need to be restructured to get back the complex valued eigenvectors. # #","eigenvectors) # automatically.** In general, pycroscopy handles compound / complex valued datasets everywhere","data_file_path = 'temp_um.h5' # download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5'","on our GitHub project page by default. You are encouraged # to download","seamlessly perform these analyses on any imaging dataset (regardless of origin, size, complexity)","The package used for creating and manipulating HDF5 files: import h5py # Plotting","= plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12)","sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\",","manipulating HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot as plt","When using your own data, you can skip this cell and provide the","component of the spectral data num_comps = 4 # get the non-negative portion","the magnitude of the imaginary component before passing to SVD. # After SVD,","component before passing to SVD. # After SVD, the real-valued eigenvectors would need","= np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)'","ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v","as is to SVD would result in # complex valued eigenvectors / endmembers","and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u =","work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired","frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of","# 2. KMeans Clustering # ==================== # # KMeans clustering is a quick","optimal labeling # (ie., assignment of each spectra as belonging to the k<sup>th</sup>","variance in descending order # * U - corresponding abundance maps # *","# clusters (sets) to partition the data into. The algorithm proceeds to find","to get back the complex valued eigenvectors. # # **Pycroscopy handles all these","abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance","\"\"\" ================================================================= Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging","px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering #","of the real and imaginary # components. So, the eigenvectors would need to","real-valued eigenvectors would need to be treated as the concatenation of the real","# get the non-negative portion of the dataset data_mat = np.abs(h5_main) model =","px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label","V - Eigenvectors sorted by variance in descending order # * U -","Complex valued abundance maps are not physical. # Thus, one would need to","position in a two # dimensional grid of spatial locations. Thus, this is","* **pycroscopy** : Though pycroscopy is mainly used here for plotting purposes only,","transformations (both for the source dataset and the eigenvectors) # automatically.** In general,","install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package for downloading online files: #","h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two","a two # dimensional matrix in accordance with the pycroscopy data format. #","matrix factorization, is a method that is useful towards unmixing of spectral #","from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy","and use your own data instead. # When using your own data, you","using your own data, you can skip this cell and provide the path","we load some spectral data, and perform basic data analysis, including: ======================================================================================== *","is a three dimensional dataset that has been flattened to a two #","Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit","from advanced atomic force microscopes. In this dataset, a spectra was collected for","it is real-valued only. # # One solution is to stack the real","NMF only works on non-negative datasets. # For illustrative purposes, we will only","the results back into the same dataset among other things \"\"\" # Import","USA In this notebook we load some spectral data, and perform basic data","estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response']","x spectra] in a two dimensional matrix. # # We will be using","<NAME> * Institute for Functional Imaging of Materials * Center for Nanophase Materials","SVD requires care and caution in interpretation. Nonetheless, it is a good method","spectra was collected for each position in a two # dimensional grid of","abundance maps # * S - Variance or importance of each of these","valued dataset. Passing the complex values as is to SVD would result in","these analyses on any imaging dataset (regardless of origin, size, complexity) and storing","num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance /","# Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity':","In general, pycroscopy handles compound / complex valued datasets everywhere possible # #","formatted in the same manner of [position x spectra] in a two dimensional","the reconstruction of the dataset using only the first N (most significant) components.","# dimensional matrix in accordance with the pycroscopy data format. # # Fortunately,","evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans clustering is","dataset (regardless of origin, size, complexity) and storing the results back into the","px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis - vector of","So, the eigenvectors would need to be restructured to get back the complex","Ridge TN 37831, USA In this notebook we load some spectral data, and","the first N (most significant) components. # # SVD results in three matrices:","=========================================== # # NMF, or non-negative matrix factorization, is a method that is","exponential drop of variance with number of components') # Visualize the eigenvectors: _","everywhere possible # # Furthermore, while it is not discussed in this example,","# 3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative","of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD","# SVD results in three matrices: # # * V - Eigenvectors sorted","# the same source h5 file including all relevant links to the source","suited for data cleaning through # the reconstruction of the dataset using only","One solution is to stack the real value followed by the magnitude of","import h5py # Plotting and visualization: import matplotlib.pyplot as plt # for downloading","Import packages # Ensure that this code works on both python 2 and","Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In this notebook we","user inputs the number of # clusters (sets) to partition the data into.","this code works on both python 2 and python 3 from __future__ import","back to # the same source h5 file including all relevant links to","# sum of squares is minimized. # # Set the number of clusters","abundance maps from # SVD requires care and caution in interpretation. Nonetheless, it","Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy,","a complex valued dataset. Passing the complex values as is to SVD would","# Set the number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main,","from # SVD requires care and caution in interpretation. Nonetheless, it is a","datasets, NMF only works on non-negative datasets. # For illustrative purposes, we will","px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data'])","is defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation","Jupyter Notebook (button at the bottom of the page) and use your own","well as abundance maps. Complex valued abundance maps are not physical. # Thus,","as abundance maps. Complex valued abundance maps are not physical. # Thus, one","num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S']","GitHub project page by default. You are encouraged # to download this document","in descending # order of variance or importance. Furthermore, SVD is also very","# Furthermore, while it is not discussed in this example, pycroscopy also writes","plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF","interpretation. Nonetheless, it is a good method for quickly # visualizing the major","bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp","to seamlessly perform these analyses on any imaging dataset (regardless of origin, size,","resultant eigenvectors are sorted in descending # order of variance or importance. Furthermore,","imaginary # components. So, the eigenvectors would need to be restructured to get","the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None)","non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from # SVD","Functional Imaging of Materials * Center for Nanophase Materials Sciences Oak Ridge National","from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== # # In","spectral data num_comps = 4 # get the non-negative portion of the dataset","the same dataset among other things \"\"\" # Import packages # Ensure that","Plotting and visualization: import matplotlib.pyplot as plt # for downloading files: import wget","has been flattened to a two # dimensional matrix in accordance with the","are not physical. # Thus, one would need to restructure the data such","_ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans","or importance of each of these components # # Advantage of pycroscopy: #","# components. So, the eigenvectors would need to be restructured to get back","components. So, the eigenvectors would need to be restructured to get back the","title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical","back into the same dataset among other things \"\"\" # Import packages #","have been collapsed to one, we need to reshape the abundance maps: abun_maps","below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels =","#') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### #","Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+')","machine learning, spectral unmixing algorithms, etc. only accept data that is # formatted","algorithms, etc. only accept data that is # formatted in the same manner","SVD is an eigenvector decomposition that is defined statistically, and therefore typically produces","default. You are encouraged # to download this document as a Jupyter Notebook","defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of","values as is to SVD would result in # complex valued eigenvectors /","= np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single',","/ statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance","or non-negative matrix factorization, is a method that is useful towards unmixing of","px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14)","page) and use your own data instead. # When using your own data,","5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components',","pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The","bottom of the page) and use your own data instead. # When using","You are encouraged # to download this document as a Jupyter Notebook (button","px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp,","to one, we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25],","not a decomposition method, but a basic clustering method. The user inputs the","approximate determination of # factors (matrices) W and H, given a matrix V,","# # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can","discussed in this example, pycroscopy also writes back the results from SVD back","Thus, this is a three dimensional dataset that has been flattened to a","that is useful towards unmixing of spectral # data. It only works on","eigenvectors would need to be treated as the concatenation of the real and","works on both python 2 and python 3 from __future__ import division, print_function,","fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the","eigenvectors. # # **Pycroscopy handles all these data transformations (both for the source","creating and manipulating HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot","of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though","print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)'","complex valued datasets everywhere possible # # Furthermore, while it is not discussed","= h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x, y)","# # KMeans clustering is a quick and easy method to determine the","the bottom of the page) and use your own data instead. # When","KMeans Clustering # ==================== # # KMeans clustering is a quick and easy","order of variance or importance. Furthermore, SVD is also very well suited for","data_file_path data_file_path = 'temp_um.h5' # download the data file from Github: url =","* KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites:","After SVD, the real-valued eigenvectors would need to be treated as the concatenation","to your data using the variable - data_file_path data_file_path = 'temp_um.h5' # download","**Pycroscopy handles all these data transformations (both for the source dataset and the","parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference","np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno',","Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831,","not found. Will install with pip.') import pip install('pycroscopy') import pycroscopy as px","##################################################################################### # The Data # ======== # # In this example, we will","======== # # In this example, we will work on a **Band Excitation","The user inputs the number of # clusters (sets) to partition the data","find the optimal labeling # (ie., assignment of each spectra as belonging to","types of spectral responses present in the # data. It is not a","these components # # Advantage of pycroscopy: # ------------------------ # Notice that we","can be applied to complex-valued datasets, NMF only works on non-negative datasets. #","Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes.","Ensure that this code works on both python 2 and python 3 from","In this example, we will work on a **Band Excitation Piezoresponse Force Microscopy","* Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard","concatenation of the real and imaginary # components. So, the eigenvectors would need","print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some","in interpretation. Nonetheless, it is a good method for quickly # visualizing the","# data. It is not a decomposition method, but a basic clustering method.","except ImportError: print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy') import","that we are working with a complex valued dataset. Passing the complex values","dimensional grid of spatial locations. Thus, this is a three dimensional dataset that","set) such that the within-cluster # sum of squares is minimized. # #","will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset #","a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units':","each spectra as belonging to the k<sup>th</sup> set) such that the within-cluster #","h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp,","freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0,","computation: import numpy as np # The package used for creating and manipulating","wget import os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import","as a Jupyter Notebook (button at the bottom of the page) and use","Value Decomposition (SVD) # ===================================== # # SVD is an eigenvector decomposition that","Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes. In this","import pycroscopy as px except ImportError: print('pycroscopy not found. Will install with pip.')","spatial locations. Thus, this is a three dimensional dataset that has been flattened","physical. # Thus, one would need to restructure the data such that it","partition the data into. The algorithm proceeds to find the optimal labeling #","decomposition method, but a basic clustering method. The user inputs the number of","Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans clustering","we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols,","component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of components') #","by approximate determination of # factors (matrices) W and H, given a matrix","variance with number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :],","of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### #","maps from # SVD requires care and caution in interpretation. Nonetheless, it is","capabilities are realized through the ability to seamlessly perform these analyses on any","abundance maps are not physical. # Thus, one would need to restructure the","reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'})","import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package])","Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept data","vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data","spectra] in a two dimensional matrix. # # We will be using an","and k-Means that can be applied to complex-valued datasets, NMF only works on","size, complexity) and storing the results back into the same dataset among other","================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials * Center","advanced atomic force microscopes. In this dataset, a spectra was collected for each","wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file)","h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] #","'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data","components # # Advantage of pycroscopy: # ------------------------ # Notice that we are","locations. Thus, this is a three dimensional dataset that has been flattened to","algorithm proceeds to find the optimal labeling # (ie., assignment of each spectra","and provide the path to your data using the variable - data_file_path data_file_path","3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative matrix","the complex valued eigenvectors. # # **Pycroscopy handles all these data transformations (both","the source dataset and the eigenvectors) # automatically.** In general, pycroscopy handles compound","numeric computation: import numpy as np # The package used for creating and","project page by default. You are encouraged # to download this document as","px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main","data with positive real values. It operates by approximate determination of # factors","eigenvectors and abundance maps from # SVD requires care and caution in interpretation.","'temp_um.h5' # download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path =","of each spectra as belonging to the k<sup>th</sup> set) such that the within-cluster","very well suited for data cleaning through # the reconstruction of the dataset","possible # # Furthermore, while it is not discussed in this example, pycroscopy","that is # formatted in the same manner of [position x spectra] in","eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from # SVD requires","valued datasets everywhere possible # # Furthermore, while it is not discussed in","only, it's true capabilities are realized through the ability to seamlessly perform these","= h5_svd_group['S'] # Since the two spatial dimensions (x, y) have been collapsed","import cluster_utils ##################################################################################### # The Data # ======== # # In this example,","data using the variable - data_file_path data_file_path = 'temp_um.h5' # download the data","HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot as plt #","was collected for each position in a two # dimensional grid of spatial","dataset. Passing the complex values as is to SVD would result in #","well suited for data cleaning through # the reconstruction of the dataset using","Oak Ridge TN 37831, USA In this notebook we load some spectral data,","# Extracting the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1]","# complex valued eigenvectors / endmembers as well as abundance maps. Complex valued","this example, pycroscopy also writes back the results from SVD back to #","in descending order # * U - corresponding abundance maps # * S","grid of spatial locations. Thus, this is a three dimensional dataset that has","for creating and manipulating HDF5 files: import h5py # Plotting and visualization: import","dimensions (x, y) have been collapsed to one, we need to reshape the","storing the results back into the same dataset among other things \"\"\" #","# ======== # # In this example, we will work on a **Band","sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used here for plotting","to SVD. # After SVD, the real-valued eigenvectors would need to be treated","Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy,","# We will be using an data file available on our GitHub project","# * U - corresponding abundance maps # * S - Variance or","file available on our GitHub project page by default. You are encouraged #","<NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials * Center for","def install(package): subprocess.call([sys.executable, \"-m\", \"pip\", \"install\", package]) # Package for downloading online files:","- Variance or importance of each of these components # # Advantage of","eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2.","the k<sup>th</sup> set) such that the within-cluster # sum of squares is minimized.","division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as np #","this document as a Jupyter Notebook (button at the bottom of the page)","complexity) and storing the results back into the same dataset among other things","descending order # * U - corresponding abundance maps # * S -","page by default. You are encouraged # to download this document as a","pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== # # In this","h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp =","only. # # One solution is to stack the real value followed by","# formatted in the same manner of [position x spectra] in a two","num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels']","caution in interpretation. Nonetheless, it is a good method for quickly # visualizing","on data with positive real values. It operates by approximate determination of #","# One solution is to stack the real value followed by the magnitude","matrix. # # We will be using an data file available on our","Advantage of pycroscopy: # ------------------------ # Notice that we are working with a","print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows')","complex-valued datasets, NMF only works on non-negative datasets. # For illustrative purposes, we","ImportError: print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy') import pycroscopy","# In this example, we will work on a **Band Excitation Piezoresponse Force","the imaginary component before passing to SVD. # After SVD, the real-valued eigenvectors","h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) #","with the pycroscopy data format. # # Fortunately, all statistical analysis, machine learning,","# Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols')","be applied to complex-valued datasets, NMF only works on non-negative datasets. # For","# visualizing the major trends in the dataset since the resultant eigenvectors are","h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular","of eigenvectors and abundance maps from # SVD requires care and caution in","would need to be treated as the concatenation of the real and imaginary","microscopes. In this dataset, a spectra was collected for each position in a","'V'}) # Extracting the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main,","complex valued eigenvectors / endmembers as well as abundance maps. Complex valued abundance","to the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group","with number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label,","number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp =","is minimized. # # Set the number of clusters below num_clusters = 4","analyses on any imaging dataset (regardless of origin, size, complexity) and storing the","spatial dimensions (x, y) have been collapsed to one, we need to reshape","non-negative matrix factorization, is a method that is useful towards unmixing of spectral","# data. It only works on data with positive real values. It operates","axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label,","acquired from advanced atomic force microscopes. In this dataset, a spectra was collected","Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and","the real and imaginary # components. So, the eigenvectors would need to be","data that is # formatted in the same manner of [position x spectra]","# * V - Eigenvectors sorted by variance in descending order # *","treated as the concatenation of the real and imaginary # components. So, the","applied to complex-valued datasets, NMF only works on non-negative datasets. # For illustrative","axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) *","or importance. Furthermore, SVD is also very well suited for data cleaning through","to # the same source h5 file including all relevant links to the","color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of each component:","non-negative portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0)","variable - data_file_path data_file_path = 'temp_um.h5' # download the data file from Github:","a spectra was collected for each position in a two # dimensional grid","to download this document as a Jupyter Notebook (button at the bottom of","Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance","spectra as belonging to the k<sup>th</sup> set) such that the within-cluster # sum","NMF, or non-negative matrix factorization, is a method that is useful towards unmixing","* 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label =","in the # data. It is not a decomposition method, but a basic","SVD back to # the same source h5 file including all relevant links","and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used here for","back the results from SVD back to # the same source h5 file","restructure the data such that it is real-valued only. # # One solution","= px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis -","and storing the results back into the same dataset among other things \"\"\"","typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps","quickly # visualizing the major trends in the dataset since the resultant eigenvectors","an data file available on our GitHub project page by default. You are","of the spectral data num_comps = 4 # get the non-negative portion of","your own data instead. # When using your own data, you can skip","and imaginary # components. So, the eigenvectors would need to be restructured to","with positive real values. It operates by approximate determination of # factors (matrices)",":25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95)","- Eigenvectors sorted by variance in descending order # * U - corresponding","------------------------ # Notice that we are working with a complex valued dataset. Passing","(button at the bottom of the page) and use your own data instead.","import division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as np","h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x,","need to restructure the data such that it is real-valued only. # #","on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from","clustering is a quick and easy method to determine the types of spectral","to a two # dimensional matrix in accordance with the pycroscopy data format.","data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters:","the exponential drop of variance with number of components') # Visualize the eigenvectors:","data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5,","numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly","as px except ImportError: print('pycroscopy not found. Will install with pip.') import pip","using an data file available on our GitHub project page by default. You","to SVD would result in # complex valued eigenvectors / endmembers as well","fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and","used for creating and manipulating HDF5 files: import h5py # Plotting and visualization:","fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the h5_file h5_file.close() os.remove(data_file_path)","responses present in the # data. It is not a decomposition method, but","for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA","======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn)","= 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of","abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True,","sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import sys def install(package):","in this example, pycroscopy also writes back the results from SVD back to","file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows","restructured to get back the complex valued eigenvectors. # # **Pycroscopy handles all","of squares is minimized. # # Set the number of clusters below num_clusters","num_comps = 4 # get the non-negative portion of the dataset data_mat =","1. Singular Value Decomposition (SVD) # ===================================== # # SVD is an eigenvector","into the same dataset among other things \"\"\" # Import packages # Ensure","# ------------------------ # Notice that we are working with a complex valued dataset.","real and imaginary # components. So, the eigenvectors would need to be restructured","will only take the amplitude component of the spectral data num_comps = 4","of the imaginary component before passing to SVD. # After SVD, the real-valued","the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop","this notebook we load some spectral data, and perform basic data analysis, including:","sorted in descending # order of variance or importance. Furthermore, SVD is also","with a complex valued dataset. Passing the complex values as is to SVD","handles compound / complex valued datasets everywhere possible # # Furthermore, while it","__future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as","are working with a complex valued dataset. Passing the complex values as is","S - Variance or importance of each of these components # # Advantage","# # Set the number of clusters below num_clusters = 4 estimator =","of [position x spectra] in a two dimensional matrix. # # We will","the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group =","# acquired from advanced atomic force microscopes. In this dataset, a spectra was","need to be treated as the concatenation of the real and imaginary #","by default. You are encouraged # to download this document as a Jupyter","X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value)","files: import h5py # Plotting and visualization: import matplotlib.pyplot as plt # for","px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== # #","/ endmembers as well as abundance maps. Complex valued abundance maps are not","data into. The algorithm proceeds to find the optimal labeling # (ie., assignment","reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of each","# # Furthermore, while it is not discussed in this example, pycroscopy also","clusters (sets) to partition the data into. The algorithm proceeds to find the","eigenvector decomposition that is defined statistically, and therefore typically produces # non-physical eigenvectors.","a two dimensional matrix. # # We will be using an data file","the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD","is not a decomposition method, but a basic clustering method. The user inputs","# ===================================== # # SVD is an eigenvector decomposition that is defined statistically,","force microscopes. In this dataset, a spectra was collected for each position in","# # Advantage of pycroscopy: # ------------------------ # Notice that we are working","Laboratory, Oak Ridge TN 37831, USA In this notebook we load some spectral","on non-negative datasets. # For illustrative purposes, we will only take the amplitude","that can be applied to complex-valued datasets, NMF only works on non-negative datasets.","= h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000']","SVD would result in # complex valued eigenvectors / endmembers as well as","==================== # # KMeans clustering is a quick and easy method to determine","# Since the two spatial dimensions (x, y) have been collapsed to one,","accept data that is # formatted in the same manner of [position x","results from SVD back to # the same source h5 file including all","will be using an data file available on our GitHub project page by","to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) #","number of # clusters (sets) to partition the data into. The algorithm proceeds","# # SVD is an eigenvector decomposition that is defined statistically, and therefore","h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions","is useful towards unmixing of spectral # data. It only works on data","the results from SVD back to # the same source h5 file including","currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' #####################################################################################","here for plotting purposes only, it's true capabilities are realized through the ability","been flattened to a two # dimensional matrix in accordance with the pycroscopy","Notebook (button at the bottom of the page) and use your own data","# # * V - Eigenvectors sorted by variance in descending order #","'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== # #","things \"\"\" # Import packages # Ensure that this code works on both","matrix in accordance with the pycroscopy data format. # # Fortunately, all statistical","W and H, given a matrix V, as shown below # # ..","(BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes. In this dataset,","Consequently, the interpretation of eigenvectors and abundance maps from # SVD requires care","before passing to SVD. # After SVD, the real-valued eigenvectors would need to","at the bottom of the page) and use your own data instead. #","proceeds to find the optimal labeling # (ie., assignment of each spectra as","SVD, the real-valued eigenvectors would need to be treated as the concatenation of","scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used","Set the number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters))","abundance maps. Complex valued abundance maps are not physical. # Thus, one would","of these components # # Advantage of pycroscopy: # ------------------------ # Notice that","the dataset since the resultant eigenvectors are sorted in descending # order of","each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of components')","use your own data instead. # When using your own data, you can","= px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp)","# # NMF, or non-negative matrix factorization, is a method that is useful","# # One solution is to stack the real value followed by the","maps are not physical. # Thus, one would need to restructure the data","three dimensional dataset that has been flattened to a two # dimensional matrix","one, we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows,","spectral data, and perform basic data analysis, including: ======================================================================================== * KMeans Clustering *","such that the within-cluster # sum of squares is minimized. # # Set","and the eigenvectors) # automatically.** In general, pycroscopy handles compound / complex valued","be using an data file available on our GitHub project page by default.","real value followed by the magnitude of the imaginary component before passing to","collapsed to one, we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:,","print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy') import pycroscopy as","'Deflection', 'units': 'V'}) # Extracting the X axis - vector of frequencies h5_spec_vals","in the same manner of [position x spectra] in a two dimensional matrix.","the number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp","inputs the number of # clusters (sets) to partition the data into. The","(kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) #","# download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url,","k-Means that can be applied to complex-valued datasets, NMF only works on non-negative","data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------')","to the k<sup>th</sup> set) such that the within-cluster # sum of squares is","Though pycroscopy is mainly used here for plotting purposes only, it's true capabilities","Factorization (NMF) # =========================================== # # NMF, or non-negative matrix factorization, is a","positive real values. It operates by approximate determination of # factors (matrices) W","components. # # SVD results in three matrices: # # * V -","- corresponding abundance maps # * S - Variance or importance of each","of # factors (matrices) W and H, given a matrix V, as shown"],"string":"[\n \"# The package used for creating and manipulating HDF5 files: import h5py #\",\n \"# Import packages # Ensure that this code works on both python 2\",\n \"files: # finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy\",\n \"method to determine the types of spectral responses present in the # data.\",\n \"px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of components') # Visualize\",\n \"factors (matrices) W and H, given a matrix V, as shown below #\",\n \"px except ImportError: print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy')\",\n \"Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force\",\n \"of the page) and use your own data instead. # When using your\",\n \"# 1. Singular Value Decomposition (SVD) # ===================================== # # SVD is an\",\n \"Notice that we are working with a complex valued dataset. Passing the complex\",\n \"# (ie., assignment of each spectra as belonging to the k<sup>th</sup> set) such\",\n \"the non-negative portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random',\",\n \"a quick and easy method to determine the types of spectral responses present\",\n \"Data # ======== # # In this example, we will work on a\",\n \"the concatenation of the real and imaginary # components. So, the eigenvectors would\",\n \"source h5 file including all relevant links to the source dataset and other\",\n \"clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels\",\n \"# finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not\",\n \"unmixing of spectral # data. It only works on data with positive real\",\n \"(x, y) have been collapsed to one, we need to reshape the abundance\",\n \"been collapsed to one, we need to reshape the abundance maps: abun_maps =\",\n \"with pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils\",\n \"source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute()\",\n \"Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) #####################################################################################\",\n \"# .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be\",\n \"= np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5))\",\n \"np # The package used for creating and manipulating HDF5 files: import h5py\",\n \"In this notebook we load some spectral data, and perform basic data analysis,\",\n \"Passing the complex values as is to SVD would result in # complex\",\n \"decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the\",\n \"data. It is not a decomposition method, but a basic clustering method. The\",\n \"from sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\",\",\n \"(SVD) # ===================================== # # SVD is an eigenvector decomposition that is defined\",\n \"Furthermore, while it is not discussed in this example, pycroscopy also writes back\",\n \"KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: =======================\",\n \"eigenvectors / endmembers as well as abundance maps. Complex valued abundance maps are\",\n \"result in # complex valued eigenvectors / endmembers as well as abundance maps.\",\n \"# After SVD, the real-valued eigenvectors would need to be treated as the\",\n \"other things \\\"\\\"\\\" # Import packages # Ensure that this code works on\",\n \"results back into the same dataset among other things \\\"\\\"\\\" # Import packages\",\n \"* Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN\",\n \"# =========================================== # # NMF, or non-negative matrix factorization, is a method that\",\n \"\\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for downloading online files: # finally import\",\n \"would need to restructure the data such that it is real-valued only. #\",\n \"h5_svd_group['S'] # Since the two spatial dimensions (x, y) have been collapsed to\",\n \"Since the two spatial dimensions (x, y) have been collapsed to one, we\",\n \"# For illustrative purposes, we will only take the amplitude component of the\",\n \"package]) # Package for downloading online files: # finally import pycroscopy: try: import\",\n \"non-negative datasets. # For illustrative purposes, we will only take the amplitude component\",\n \"Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative matrix factorization,\",\n \"and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and\",\n \"V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD\",\n \"the data into. The algorithm proceeds to find the optimal labeling # (ie.,\",\n \"matplotlib.pyplot as plt # for downloading files: import wget import os # multivariate\",\n \"importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number\",\n \"(matrices) W and H, given a matrix V, as shown below # #\",\n \"two dimensional matrix. # # We will be using an data file available\",\n \"amplitude component of the spectral data num_comps = 4 # get the non-negative\",\n \"k<sup>th</sup> set) such that the within-cluster # sum of squares is minimized. #\",\n \"dataset using only the first N (most significant) components. # # SVD results\",\n \"is # formatted in the same manner of [position x spectra] in a\",\n \"for quickly # visualizing the major trends in the dataset since the resultant\",\n \"the spectral data num_comps = 4 # get the non-negative portion of the\",\n \"Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy**\",\n \"= 4 # get the non-negative portion of the dataset data_mat = np.abs(h5_main)\",\n \"= wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------')\",\n \"dataset, a spectra was collected for each position in a two # dimensional\",\n \"within-cluster # sum of squares is minimized. # # Set the number of\",\n \"a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced\",\n \"care and caution in interpretation. Nonetheless, it is a good method for quickly\",\n \"analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal Component\",\n \"(a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== # # SVD\",\n \"labeling # (ie., assignment of each spectra as belonging to the k<sup>th</sup> set)\",\n \"to complex-valued datasets, NMF only works on non-negative datasets. # For illustrative purposes,\",\n \"subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for\",\n \"of spectral # data. It only works on data with positive real values.\",\n \"title_yoffset=0.95) # Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note\",\n \"the optimal labeling # (ie., assignment of each spectra as belonging to the\",\n \"Extracting the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec\",\n \"example, pycroscopy also writes back the results from SVD back to # the\",\n \"be restructured to get back the complex valued eigenvectors. # # **Pycroscopy handles\",\n \"handles all these data transformations (both for the source dataset and the eigenvectors)\",\n \"and python 3 from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric\",\n \"import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not found. Will\",\n \"valued abundance maps are not physical. # Thus, one would need to restructure\",\n \"belonging to the k<sup>th</sup> set) such that the within-cluster # sum of squares\",\n \"# Notice that we are working with a complex valued dataset. Passing the\",\n \"Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential\",\n \"# The Data # ======== # # In this example, we will work\",\n \"Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the h5_file h5_file.close()\",\n \"axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the h5_file\",\n \"are realized through the ability to seamlessly perform these analyses on any imaging\",\n \"and visualization: import matplotlib.pyplot as plt # for downloading files: import wget import\",\n \"importance. Furthermore, SVD is also very well suited for data cleaning through #\",\n \"and easy method to determine the types of spectral responses present in the\",\n \"x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value\",\n \"Nonetheless, it is a good method for quickly # visualizing the major trends\",\n \"try: import pycroscopy as px except ImportError: print('pycroscopy not found. Will install with\",\n \"dataset and the eigenvectors) # automatically.** In general, pycroscopy handles compound / complex\",\n \"of variance or importance. Furthermore, SVD is also very well suited for data\",\n \"compound / complex valued datasets everywhere possible # # Furthermore, while it is\",\n \"import os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF\",\n \"your own data, you can skip this cell and provide the path to\",\n \"the dataset using only the first N (most significant) components. # # SVD\",\n \"matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used here\",\n \"# Ensure that this code works on both python 2 and python 3\",\n \"etc. only accept data that is # formatted in the same manner of\",\n \"* V - Eigenvectors sorted by variance in descending order # * U\",\n \"get the non-negative portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps,\",\n \"python 3 from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation:\",\n \"# Plotting and visualization: import matplotlib.pyplot as plt # for downloading files: import\",\n \"you can skip this cell and provide the path to your data using\",\n \"provide the path to your data using the variable - data_file_path data_file_path =\",\n \"to be treated as the concatenation of the real and imaginary # components.\",\n \"Will install with pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz\",\n \"true capabilities are realized through the ability to seamlessly perform these analyses on\",\n \"we will only take the amplitude component of the spectral data num_comps =\",\n \"it is not discussed in this example, pycroscopy also writes back the results\",\n \"# factors (matrices) W and H, given a matrix V, as shown below\",\n \"dataset among other things \\\"\\\"\\\" # Import packages # Ensure that this code\",\n \"in the dataset since the resultant eigenvectors are sorted in descending # order\",\n \"python 2 and python 3 from __future__ import division, print_function, absolute_import, unicode_literals #\",\n \"We will be using an data file available on our GitHub project page\",\n \"the two spatial dimensions (x, y) have been collapsed to one, we need\",\n \"but a basic clustering method. The user inputs the number of # clusters\",\n \"px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance\",\n \"that has been flattened to a two # dimensional matrix in accordance with\",\n \"in three matrices: # # * V - Eigenvectors sorted by variance in\",\n \"##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans clustering is a\",\n \"both python 2 and python 3 from __future__ import division, print_function, absolute_import, unicode_literals\",\n \"unmixing algorithms, etc. only accept data that is # formatted in the same\",\n \"# SVD requires care and caution in interpretation. Nonetheless, it is a good\",\n \"imaging dataset # acquired from advanced atomic force microscopes. In this dataset, a\",\n \"2 and python 3 from __future__ import division, print_function, absolute_import, unicode_literals # basic\",\n \"h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # ===========================================\",\n \"import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for downloading\",\n \"dataset # acquired from advanced atomic force microscopes. In this dataset, a spectra\",\n \"by variance in descending order # * U - corresponding abundance maps #\",\n \"perform these analyses on any imaging dataset (regardless of origin, size, complexity) and\",\n \"random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #')\",\n \"perform basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization\",\n \"KMeans from sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\",\",\n \"\\\"pip\\\", \\\"install\\\", package]) # Package for downloading online files: # finally import pycroscopy:\",\n \"= px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s\",\n \"the major trends in the dataset since the resultant eigenvectors are sorted in\",\n \"good method for quickly # visualizing the major trends in the dataset since\",\n \"for each position in a two # dimensional grid of spatial locations. Thus,\",\n \"dimensional dataset that has been flattened to a two # dimensional matrix in\",\n \"# # In this example, we will work on a **Band Excitation Piezoresponse\",\n \"pycroscopy handles compound / complex valued datasets everywhere possible # # Furthermore, while\",\n \"reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9,\",\n \"h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization\",\n \"notebook we load some spectral data, and perform basic data analysis, including: ========================================================================================\",\n \"of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig,\",\n \"3 from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation: import\",\n \"* S - Variance or importance of each of these components # #\",\n \"also writes back the results from SVD back to # the same source\",\n \"can skip this cell and provide the path to your data using the\",\n \"= h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols =\",\n \"= px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering\",\n \"It operates by approximate determination of # factors (matrices) W and H, given\",\n \"SVD and k-Means that can be applied to complex-valued datasets, NMF only works\",\n \"Institute for Functional Imaging of Materials * Center for Nanophase Materials Sciences Oak\",\n \"also very well suited for data cleaning through # the reconstruction of the\",\n \"the number of # clusters (sets) to partition the data into. The algorithm\",\n \"Materials * Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge\",\n \"for plotting purposes only, it's true capabilities are realized through the ability to\",\n \"as well as abundance maps. Complex valued abundance maps are not physical. #\",\n \"be treated as the concatenation of the real and imaginary # components. So,\",\n \"h5 file including all relevant links to the source dataset and other ancillary\",\n \"endmembers as well as abundance maps. Complex valued abundance maps are not physical.\",\n \"absolute_import, unicode_literals # basic numeric computation: import numpy as np # The package\",\n \"some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting\",\n \"a matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # #\",\n \"Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of\",\n \"**pycroscopy** : Though pycroscopy is mainly used here for plotting purposes only, it's\",\n \"the amplitude component of the spectral data num_comps = 4 # get the\",\n \"as plt # for downloading files: import wget import os # multivariate analysis:\",\n \"# # **Pycroscopy handles all these data transformations (both for the source dataset\",\n \"= 'temp_um.h5' # download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path\",\n \"# the reconstruction of the dataset using only the first N (most significant)\",\n \"as np # The package used for creating and manipulating HDF5 files: import\",\n \"same source h5 file including all relevant links to the source dataset and\",\n \"Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In\",\n \"working with a complex valued dataset. Passing the complex values as is to\",\n \"of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main)\",\n \"valued eigenvectors / endmembers as well as abundance maps. Complex valued abundance maps\",\n \"================================================================= Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of\",\n \"import KMeans from sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable,\",\n \"take the amplitude component of the spectral data num_comps = 4 # get\",\n \"dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u\",\n \"the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### #\",\n \"these data transformations (both for the source dataset and the eigenvectors) # automatically.**\",\n \"import subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package\",\n \"a good method for quickly # visualizing the major trends in the dataset\",\n \"h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3.\",\n \"dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis =\",\n \"data transformations (both for the source dataset and the eigenvectors) # automatically.** In\",\n \"= 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition\",\n \"as the concatenation of the real and imaginary # components. So, the eigenvectors\",\n \"interpretation of eigenvectors and abundance maps from # SVD requires care and caution\",\n \"Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials *\",\n \"SVD. # After SVD, the real-valued eigenvectors would need to be treated as\",\n \"illustrative purposes, we will only take the amplitude component of the spectral data\",\n \"(most significant) components. # # SVD results in three matrices: # # *\",\n \"h5py # Plotting and visualization: import matplotlib.pyplot as plt # for downloading files:\",\n \"example, we will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging\",\n \"need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1))\",\n \"x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== #\",\n \"to stack the real value followed by the magnitude of the imaginary component\",\n \"and H, given a matrix V, as shown below # # .. image::\",\n \"drop of variance with number of components') # Visualize the eigenvectors: _ =\",\n \"data such that it is real-valued only. # # One solution is to\",\n \"towards unmixing of spectral # data. It only works on data with positive\",\n \"a basic clustering method. The user inputs the number of # clusters (sets)\",\n \"(ie., assignment of each spectra as belonging to the k<sup>th</sup> set) such that\",\n \"the same source h5 file including all relevant links to the source dataset\",\n \"import numpy as np # The package used for creating and manipulating HDF5\",\n \"plt # for downloading files: import wget import os # multivariate analysis: from\",\n \"that this code works on both python 2 and python 3 from __future__\",\n \"passing to SVD. # After SVD, the real-valued eigenvectors would need to be\",\n \"through the ability to seamlessly perform these analyses on any imaging dataset (regardless\",\n \"writes back the results from SVD back to # the same source h5\",\n \"px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis - vector\",\n \"method. The user inputs the number of # clusters (sets) to partition the\",\n \"order # * U - corresponding abundance maps # * S - Variance\",\n \"'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset:\",\n \"Eigenvectors sorted by variance in descending order # * U - corresponding abundance\",\n \"maps # * S - Variance or importance of each of these components\",\n \".. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be applied\",\n \"datasets. # For illustrative purposes, we will only take the amplitude component of\",\n \"= h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF)\",\n \"analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import sys\",\n \"it is a good method for quickly # visualizing the major trends in\",\n \"# multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess\",\n \"available on our GitHub project page by default. You are encouraged # to\",\n \"only works on non-negative datasets. # For illustrative purposes, we will only take\",\n \"the real value followed by the magnitude of the imaginary component before passing\",\n \"# NMF, or non-negative matrix factorization, is a method that is useful towards\",\n \"\\\"install\\\", package]) # Package for downloading online files: # finally import pycroscopy: try:\",\n \"maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps',\",\n \"(both for the source dataset and the eigenvectors) # automatically.** In general, pycroscopy\",\n \"to find the optimal labeling # (ie., assignment of each spectra as belonging\",\n \"Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda**\",\n \"our GitHub project page by default. You are encouraged # to download this\",\n \"the eigenvectors would need to be restructured to get back the complex valued\",\n \"shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means\",\n \"NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF\",\n \"4 # get the non-negative portion of the dataset data_mat = np.abs(h5_main) model\",\n \"of Materials * Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak\",\n \"it's true capabilities are realized through the ability to seamlessly perform these analyses\",\n \"# # Unlike SVD and k-Means that can be applied to complex-valued datasets,\",\n \"estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix\",\n \"manner of [position x spectra] in a two dimensional matrix. # # We\",\n \"install with pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import\",\n \"num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset: h5_main\",\n \"instead. # When using your own data, you can skip this cell and\",\n \"- vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3\",\n \"complex values as is to SVD would result in # complex valued eigenvectors\",\n \"we will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset\",\n \"(num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) #\",\n \"# **Pycroscopy handles all these data transformations (both for the source dataset and\",\n \"import matplotlib.pyplot as plt # for downloading files: import wget import os #\",\n \"using the variable - data_file_path data_file_path = 'temp_um.h5' # download the data file\",\n \"would result in # complex valued eigenvectors / endmembers as well as abundance\",\n \"init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component\",\n \"**Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic\",\n \"the page) and use your own data instead. # When using your own\",\n \"found. Will install with pip.') import pip install('pycroscopy') import pycroscopy as px from\",\n \"# to download this document as a Jupyter Notebook (button at the bottom\",\n \"below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that\",\n \"magnitude of the imaginary component before passing to SVD. # After SVD, the\",\n \"into. The algorithm proceeds to find the optimal labeling # (ie., assignment of\",\n \"including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis\",\n \"learning, spectral unmixing algorithms, etc. only accept data that is # formatted in\",\n \"data num_comps = 4 # get the non-negative portion of the dataset data_mat\",\n \"the within-cluster # sum of squares is minimized. # # Set the number\",\n \"for downloading online files: # finally import pycroscopy: try: import pycroscopy as px\",\n \"variance or importance. Furthermore, SVD is also very well suited for data cleaning\",\n \"to be restructured to get back the complex valued eigenvectors. # # **Pycroscopy\",\n \"works on non-negative datasets. # For illustrative purposes, we will only take the\",\n \"the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting\",\n \"===================================== # # SVD is an eigenvector decomposition that is defined statistically, and\",\n \"is to SVD would result in # complex valued eigenvectors / endmembers as\",\n \"import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data #\",\n \"matrices: # # * V - Eigenvectors sorted by variance in descending order\",\n \"the resultant eigenvectors are sorted in descending # order of variance or importance.\",\n \"SVD is also very well suited for data cleaning through # the reconstruction\",\n \"is mainly used here for plotting purposes only, it's true capabilities are realized\",\n \"1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude\",\n \"title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans\",\n \"eigenvectors would need to be restructured to get back the complex valued eigenvectors.\",\n \"a decomposition method, but a basic clustering method. The user inputs the number\",\n \"import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### #\",\n \":], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ====================\",\n \"label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12)\",\n \"model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec,\",\n \"* Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes\",\n \"unicode_literals # basic numeric computation: import numpy as np # The package used\",\n \"eigenvectors are sorted in descending # order of variance or importance. Furthermore, SVD\",\n \"Package for downloading online files: # finally import pycroscopy: try: import pycroscopy as\",\n \"in # complex valued eigenvectors / endmembers as well as abundance maps. Complex\",\n \"imaging dataset (regardless of origin, size, complexity) and storing the results back into\",\n \"Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= *\",\n \"major trends in the dataset since the resultant eigenvectors are sorted in descending\",\n \"while it is not discussed in this example, pycroscopy also writes back the\",\n \"number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label,\",\n \"general, pycroscopy handles compound / complex valued datasets everywhere possible # # Furthermore,\",\n \"value followed by the magnitude of the imaginary component before passing to SVD.\",\n \"= 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp\",\n \"and perform basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix\",\n \"accordance with the pycroscopy data format. # # Fortunately, all statistical analysis, machine\",\n \"file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file =\",\n \"maps. Complex valued abundance maps are not physical. # Thus, one would need\",\n \"Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of\",\n \"all these data transformations (both for the source dataset and the eigenvectors) #\",\n \"Clustering # ==================== # # KMeans clustering is a quick and easy method\",\n \"only take the amplitude component of the spectral data num_comps = 4 #\",\n \"spectral # data. It only works on data with positive real values. It\",\n \"* Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) *\",\n \"The algorithm proceeds to find the optimal labeling # (ie., assignment of each\",\n \"import wget import os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition\",\n \"basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization *\",\n \"Thus, one would need to restructure the data such that it is real-valued\",\n \"of # clusters (sets) to partition the data into. The algorithm proceeds to\",\n \"method, but a basic clustering method. The user inputs the number of #\",\n \"h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== # #\",\n \"is not discussed in this example, pycroscopy also writes back the results from\",\n \"two # dimensional matrix in accordance with the pycroscopy data format. # #\",\n \"mainly used here for plotting purposes only, it's true capabilities are realized through\",\n \"load some spectral data, and perform basic data analysis, including: ======================================================================================== * KMeans\",\n \"h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis\",\n \"works on data with positive real values. It operates by approximate determination of\",\n \"2. KMeans Clustering # ==================== # # KMeans clustering is a quick and\",\n \"for downloading files: import wget import os # multivariate analysis: from sklearn.cluster import\",\n \"imaginary component before passing to SVD. # After SVD, the real-valued eigenvectors would\",\n \"Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In this notebook\",\n \"squares is minimized. # # Set the number of clusters below num_clusters =\",\n \"multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import\",\n \"flattened to a two # dimensional matrix in accordance with the pycroscopy data\",\n \"the pycroscopy data format. # # Fortunately, all statistical analysis, machine learning, spectral\",\n \"are sorted in descending # order of variance or importance. Furthermore, SVD is\",\n \"plotting purposes only, it's true capabilities are realized through the ability to seamlessly\",\n \"for Functional Imaging of Materials * Center for Nanophase Materials Sciences Oak Ridge\",\n \"the data such that it is real-valued only. # # One solution is\",\n \"packages # Ensure that this code works on both python 2 and python\",\n \"descending # order of variance or importance. Furthermore, SVD is also very well\",\n \"\\\"\\\"\\\" # Import packages # Ensure that this code works on both python\",\n \"Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard distribution\",\n \"# When using your own data, you can skip this cell and provide\",\n \"valued eigenvectors. # # **Pycroscopy handles all these data transformations (both for the\",\n \"In this dataset, a spectra was collected for each position in a two\",\n \"visualization: import matplotlib.pyplot as plt # for downloading files: import wget import os\",\n \"# # Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc. only\",\n \"three matrices: # # * V - Eigenvectors sorted by variance in descending\",\n \"complex valued eigenvectors. # # **Pycroscopy handles all these data transformations (both for\",\n \"automatically.** In general, pycroscopy handles compound / complex valued datasets everywhere possible #\",\n \"(sets) to partition the data into. The algorithm proceeds to find the optimal\",\n \"px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) #####################################################################################\",\n \"is a method that is useful towards unmixing of spectral # data. It\",\n \"Unlike SVD and k-Means that can be applied to complex-valued datasets, NMF only\",\n \"'grid_num_cols') # Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main,\",\n \"is an eigenvector decomposition that is defined statistically, and therefore typically produces #\",\n \"y) have been collapsed to one, we need to reshape the abundance maps:\",\n \"code works on both python 2 and python 3 from __future__ import division,\",\n \"freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency\",\n \"main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the\",\n \"method for quickly # visualizing the major trends in the dataset since the\",\n \"the eigenvectors) # automatically.** In general, pycroscopy handles compound / complex valued datasets\",\n \"cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF,\",\n \"corresponding abundance maps # * S - Variance or importance of each of\",\n \"realized through the ability to seamlessly perform these analyses on any imaging dataset\",\n \"solution is to stack the real value followed by the magnitude of the\",\n \"that the within-cluster # sum of squares is minimized. # # Set the\",\n \"of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic\",\n \"portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat)\",\n \"data cleaning through # the reconstruction of the dataset using only the first\",\n \"h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x, y) have been\",\n \"axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close\",\n \"##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or\",\n \"all statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept data that\",\n \"each of these components # # Advantage of pycroscopy: # ------------------------ # Notice\",\n \"sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for downloading online\",\n \"dataset that has been flattened to a two # dimensional matrix in accordance\",\n \"assignment of each spectra as belonging to the k<sup>th</sup> set) such that the\",\n \"given a matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png #\",\n \"datasets everywhere possible # # Furthermore, while it is not discussed in this\",\n \"For illustrative purposes, we will only take the amplitude component of the spectral\",\n \"is also very well suited for data cleaning through # the reconstruction of\",\n \"subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for downloading online files: # finally\",\n \"from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path,\",\n \"the variable - data_file_path data_file_path = 'temp_um.h5' # download the data file from\",\n \"purposes, we will only take the amplitude component of the spectral data num_comps\",\n \"a Jupyter Notebook (button at the bottom of the page) and use your\",\n \"basic clustering method. The user inputs the number of # clusters (sets) to\",\n \"quick and easy method to determine the types of spectral responses present in\",\n \"this is a three dimensional dataset that has been flattened to a two\",\n \"that is defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the\",\n \"present in the # data. It is not a decomposition method, but a\",\n \"# Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept\",\n \"= h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial\",\n \"data format. # # Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms,\",\n \"= px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape)\",\n \"num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize\",\n \"# ==================== # # KMeans clustering is a quick and easy method to\",\n \"37831, USA In this notebook we load some spectral data, and perform basic\",\n \"data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal\",\n \"Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib\",\n \"= estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative\",\n \"produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from\",\n \"dataset since the resultant eigenvectors are sorted in descending # order of variance\",\n \"your data using the variable - data_file_path data_file_path = 'temp_um.h5' # download the\",\n \"and caution in interpretation. Nonetheless, it is a good method for quickly #\",\n \"ability to seamlessly perform these analyses on any imaging dataset (regardless of origin,\",\n \"SVD results in three matrices: # # * V - Eigenvectors sorted by\",\n \"# automatically.** In general, pycroscopy handles compound / complex valued datasets everywhere possible\",\n \"print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as np # The\",\n \"/ complex valued datasets everywhere possible # # Furthermore, while it is not\",\n \"importance of each of these components # # Advantage of pycroscopy: # ------------------------\",\n \"matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike\",\n \"only works on data with positive real values. It operates by approximate determination\",\n \"by the magnitude of the imaginary component before passing to SVD. # After\",\n \"results in three matrices: # # * V - Eigenvectors sorted by variance\",\n \"links to the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100)\",\n \"variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of\",\n \"is a quick and easy method to determine the types of spectral responses\",\n \"cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s,\",\n \"the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis\",\n \"each position in a two # dimensional grid of spatial locations. Thus, this\",\n \"statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept data that is\",\n \"data, and perform basic data analysis, including: ======================================================================================== * KMeans Clustering * Non-negative\",\n \"**Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy\",\n \"# non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from #\",\n \"finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not found.\",\n \"# * S - Variance or importance of each of these components #\",\n \"mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting\",\n \"(NMF) # =========================================== # # NMF, or non-negative matrix factorization, is a method\",\n \"such that it is real-valued only. # # One solution is to stack\",\n \"through # the reconstruction of the dataset using only the first N (most\",\n \"# for downloading files: import wget import os # multivariate analysis: from sklearn.cluster\",\n \"downloading files: import wget import os # multivariate analysis: from sklearn.cluster import KMeans\",\n \"first N (most significant) components. # # SVD results in three matrices: #\",\n \"of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of\",\n \"of variance with number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9,\",\n \"to determine the types of spectral responses present in the # data. It\",\n \"easy method to determine the types of spectral responses present in the #\",\n \"cell and provide the path to your data using the variable - data_file_path\",\n \"this dataset, a spectra was collected for each position in a two #\",\n \"components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors',\",\n \"sorted by variance in descending order # * U - corresponding abundance maps\",\n \"determine the types of spectral responses present in the # data. It is\",\n \"of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently\",\n \"decomposition that is defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently,\",\n \"of pycroscopy: # ------------------------ # Notice that we are working with a complex\",\n \"Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In this\",\n \"clustering method. The user inputs the number of # clusters (sets) to partition\",\n \"any imaging dataset (regardless of origin, size, complexity) and storing the results back\",\n \"basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a\",\n \"# Package for downloading online files: # finally import pycroscopy: try: import pycroscopy\",\n \"Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes. In\",\n \"origin, size, complexity) and storing the results back into the same dataset among\",\n \"It is not a decomposition method, but a basic clustering method. The user\",\n \"# SVD is an eigenvector decomposition that is defined statistically, and therefore typically\",\n \"model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label,\",\n \"spectral unmixing algorithms, etc. only accept data that is # formatted in the\",\n \"own data, you can skip this cell and provide the path to your\",\n \"an eigenvector decomposition that is defined statistically, and therefore typically produces # non-physical\",\n \"= h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) # =========================================== #\",\n \"all relevant links to the source dataset and other ancillary datasets decomposer =\",\n \"among other things \\\"\\\"\\\" # Import packages # Ensure that this code works\",\n \"{'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis - vector of frequencies\",\n \"not discussed in this example, pycroscopy also writes back the results from SVD\",\n \"image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be applied to\",\n \"data, you can skip this cell and provide the path to your data\",\n \"useful towards unmixing of spectral # data. It only works on data with\",\n \"the # data. It is not a decomposition method, but a basic clustering\",\n \"Variance or importance of each of these components # # Advantage of pycroscopy:\",\n \"we are working with a complex valued dataset. Passing the complex values as\",\n \"values. It operates by approximate determination of # factors (matrices) W and H,\",\n \"= px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset: h5_main =\",\n \"statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors\",\n \"Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) #####################################################################################\",\n \"(includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is\",\n \"= px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the\",\n \"to partition the data into. The algorithm proceeds to find the optimal labeling\",\n \"as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and\",\n \"of spatial locations. Thus, this is a three dimensional dataset that has been\",\n \"of the dataset using only the first N (most significant) components. # #\",\n \"Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials\",\n \"same manner of [position x spectra] in a two dimensional matrix. # #\",\n \"learn) * **pycroscopy** : Though pycroscopy is mainly used here for plotting purposes\",\n \"h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols\",\n \"cleaning through # the reconstruction of the dataset using only the first N\",\n \"is real-valued only. # # One solution is to stack the real value\",\n \"of spectral responses present in the # data. It is not a decomposition\",\n \"real values. It operates by approximate determination of # factors (matrices) W and\",\n \"Furthermore, SVD is also very well suited for data cleaning through # the\",\n \"pycroscopy also writes back the results from SVD back to # the same\",\n \"National Laboratory, Oak Ridge TN 37831, USA In this notebook we load some\",\n \"as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== #\",\n \"including all relevant links to the source dataset and other ancillary datasets decomposer\",\n \"method that is useful towards unmixing of spectral # data. It only works\",\n \"the ability to seamlessly perform these analyses on any imaging dataset (regardless of\",\n \"num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to\",\n \"requires care and caution in interpretation. Nonetheless, it is a good method for\",\n \"title='Note the exponential drop of variance with number of components') # Visualize the\",\n \"pip.') import pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils #####################################################################################\",\n \"are encouraged # to download this document as a Jupyter Notebook (button at\",\n \"model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0],\",\n \"datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v =\",\n \"not physical. # Thus, one would need to restructure the data such that\",\n \"atomic force microscopes. In this dataset, a spectra was collected for each position\",\n \"to restructure the data such that it is real-valued only. # # One\",\n \"a two # dimensional grid of spatial locations. Thus, this is a three\",\n \"online files: # finally import pycroscopy: try: import pycroscopy as px except ImportError:\",\n \"for data cleaning through # the reconstruction of the dataset using only the\",\n \"px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s =\",\n \"data file available on our GitHub project page by default. You are encouraged\",\n \"the same manner of [position x spectra] in a two dimensional matrix. #\",\n \"minimized. # # Set the number of clusters below num_clusters = 4 estimator\",\n \"the path to your data using the variable - data_file_path data_file_path = 'temp_um.h5'\",\n \"'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD)\",\n \"on both python 2 and python 3 from __future__ import division, print_function, absolute_import,\",\n \"complex valued dataset. Passing the complex values as is to SVD would result\",\n \"document as a Jupyter Notebook (button at the bottom of the page) and\",\n \"cluster_utils ##################################################################################### # The Data # ======== # # In this example, we\",\n \"[position x spectra] in a two dimensional matrix. # # We will be\",\n \"* U - corresponding abundance maps # * S - Variance or importance\",\n \"dimensional matrix in accordance with the pycroscopy data format. # # Fortunately, all\",\n \"= 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== #\",\n \"only accept data that is # formatted in the same manner of [position\",\n \"# Visualize the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the\",\n \"KMeans clustering is a quick and easy method to determine the types of\",\n \"from sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import sys def\",\n \"TN 37831, USA In this notebook we load some spectral data, and perform\",\n \"real-valued only. # # One solution is to stack the real value followed\",\n \"The Data # ======== # # In this example, we will work on\",\n \"other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U']\",\n \"two # dimensional grid of spatial locations. Thus, this is a three dimensional\",\n \"# Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False)\",\n \"y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # #\",\n \"<gh_stars>0 \\\"\\\"\\\" ================================================================= Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional\",\n \"download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path,\",\n \"of origin, size, complexity) and storing the results back into the same dataset\",\n \"two spatial dimensions (x, y) have been collapsed to one, we need to\",\n \"# # We will be using an data file available on our GitHub\",\n \"the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec =\",\n \"data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file\",\n \"print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows =\",\n \"h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:',\",\n \"NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) #\",\n \"in accordance with the pycroscopy data format. # # Fortunately, all statistical analysis,\",\n \"downloading online files: # finally import pycroscopy: try: import pycroscopy as px except\",\n \"would need to be restructured to get back the complex valued eigenvectors. #\",\n \"same dataset among other things \\\"\\\"\\\" # Import packages # Ensure that this\",\n \"= NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_,\",\n \"used here for plotting purposes only, it's true capabilities are realized through the\",\n \"is a good method for quickly # visualizing the major trends in the\",\n \"in a two # dimensional grid of spatial locations. Thus, this is a\",\n \"collected for each position in a two # dimensional grid of spatial locations.\",\n \"np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label\",\n \"one would need to restructure the data such that it is real-valued only.\",\n \"the real-valued eigenvectors would need to be treated as the concatenation of the\",\n \"numpy as np # The package used for creating and manipulating HDF5 files:\",\n \"os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import NMF import\",\n \"pycroscopy data format. # # Fortunately, all statistical analysis, machine learning, spectral unmixing\",\n \"factorization, is a method that is useful towards unmixing of spectral # data.\",\n \"h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x, y) have\",\n \"data. It only works on data with positive real values. It operates by\",\n \"Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection',\",\n \"encouraged # to download this document as a Jupyter Notebook (button at the\",\n \"skip this cell and provide the path to your data using the variable\",\n \"Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') #\",\n \"'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label =\",\n \"spectral responses present in the # data. It is not a decomposition method,\",\n \"format. # # Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc.\",\n \"from SVD back to # the same source h5 file including all relevant\",\n \"determination of # factors (matrices) W and H, given a matrix V, as\",\n \"pycroscopy is mainly used here for plotting purposes only, it's true capabilities are\",\n \"files: import wget import os # multivariate analysis: from sklearn.cluster import KMeans from\",\n \"U - corresponding abundance maps # * S - Variance or importance of\",\n \"= decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since\",\n \"# KMeans clustering is a quick and easy method to determine the types\",\n \"a method that is useful towards unmixing of spectral # data. It only\",\n \"distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** :\",\n \"back the complex valued eigenvectors. # # **Pycroscopy handles all these data transformations\",\n \"# Advantage of pycroscopy: # ------------------------ # Notice that we are working with\",\n \"this example, we will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)**\",\n \"Ridge National Laboratory, Oak Ridge TN 37831, USA In this notebook we load\",\n \"the interpretation of eigenvectors and abundance maps from # SVD requires care and\",\n \"of each of these components # # Advantage of pycroscopy: # ------------------------ #\",\n \"- data_file_path data_file_path = 'temp_um.h5' # download the data file from Github: url\",\n \"to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps,\",\n \"y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # =====================================\",\n \"KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### #\",\n \"source dataset and the eigenvectors) # automatically.** In general, pycroscopy handles compound /\",\n \"visualizing the major trends in the dataset since the resultant eigenvectors are sorted\",\n \"in a two dimensional matrix. # # We will be using an data\",\n \"dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X\",\n \"package used for creating and manipulating HDF5 files: import h5py # Plotting and\",\n \": Though pycroscopy is mainly used here for plotting purposes only, it's true\",\n \"# basic numeric computation: import numpy as np # The package used for\",\n \"pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy not found. Will install\",\n \"analysis, machine learning, spectral unmixing algorithms, etc. only accept data that is #\",\n \"path to your data using the variable - data_file_path data_file_path = 'temp_um.h5' #\",\n \"the complex values as is to SVD would result in # complex valued\",\n \"relevant links to the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main,\",\n \"sum of squares is minimized. # # Set the number of clusters below\",\n \"since the resultant eigenvectors are sorted in descending # order of variance or\",\n \"np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis,\",\n \"data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:')\",\n \"(regardless of origin, size, complexity) and storing the results back into the same\",\n \"pycroscopy as px except ImportError: print('pycroscopy not found. Will install with pip.') import\",\n \"dimensional matrix. # # We will be using an data file available on\",\n \"======================================================================================== * KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software\",\n \"url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents\",\n \"trends in the dataset since the resultant eigenvectors are sorted in descending #\",\n \"followed by the magnitude of the imaginary component before passing to SVD. #\",\n \"decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V']\",\n \"using only the first N (most significant) components. # # SVD results in\",\n \"# # SVD results in three matrices: # # * V - Eigenvectors\",\n \"Imaging of Materials * Center for Nanophase Materials Sciences Oak Ridge National Laboratory,\",\n \"# dimensional grid of spatial locations. Thus, this is a three dimensional dataset\",\n \"4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp =\",\n \"https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can be applied to complex-valued\",\n \"a three dimensional dataset that has been flattened to a two # dimensional\",\n \"Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative matrix factorization, is\",\n \"# Thus, one would need to restructure the data such that it is\",\n \"own data instead. # When using your own data, you can skip this\",\n \"download this document as a Jupyter Notebook (button at the bottom of the\",\n \"# Unlike SVD and k-Means that can be applied to complex-valued datasets, NMF\",\n \"'units': 'V'}) # Extracting the X axis - vector of frequencies h5_spec_vals =\",\n \"data instead. # When using your own data, you can skip this cell\",\n \"statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with\",\n \"N (most significant) components. # # SVD results in three matrices: # #\",\n \"is to stack the real value followed by the magnitude of the imaginary\",\n \"pycroscopy: # ------------------------ # Notice that we are working with a complex valued\",\n \"and abundance maps from # SVD requires care and caution in interpretation. Nonetheless,\",\n \"pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ========\",\n \"Decomposition (SVD) # ===================================== # # SVD is an eigenvector decomposition that is\",\n \"get back the complex valued eigenvectors. # # **Pycroscopy handles all these data\",\n \"H, given a matrix V, as shown below # # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png\",\n \"on any imaging dataset (regardless of origin, size, complexity) and storing the results\",\n \"for the source dataset and the eigenvectors) # automatically.** In general, pycroscopy handles\",\n \"Singular Value Decomposition (SVD) # ===================================== # # SVD is an eigenvector decomposition\",\n \"the types of spectral responses present in the # data. It is not\",\n \"that it is real-valued only. # # One solution is to stack the\",\n \"stack the real value followed by the magnitude of the imaginary component before\",\n \"some spectral data, and perform basic data analysis, including: ======================================================================================== * KMeans Clustering\",\n \"basic numeric computation: import numpy as np # The package used for creating\",\n \"h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] #\",\n \"axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete\",\n \"this cell and provide the path to your data using the variable -\",\n \"* Institute for Functional Imaging of Materials * Center for Nanophase Materials Sciences\",\n \"operates by approximate determination of # factors (matrices) W and H, given a\",\n \"# order of variance or importance. Furthermore, SVD is also very well suited\",\n \"<NAME>, <NAME> * Institute for Functional Imaging of Materials * Center for Nanophase\",\n \"install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data\",\n \"and manipulating HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot as\",\n \"##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== # # SVD is\",\n \"reconstruction of the dataset using only the first N (most significant) components. #\",\n \"shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1.\",\n \"only the first N (most significant) components. # # SVD results in three\",\n \"significant) components. # # SVD results in three matrices: # # * V\",\n \"file including all relevant links to the source dataset and other ancillary datasets\",\n \"-1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the\",\n \"It only works on data with positive real values. It operates by approximate\",\n \"fig, axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12)\",\n \"as belonging to the k<sup>th</sup> set) such that the within-cluster # sum of\",\n \"therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance\",\n \"purposes only, it's true capabilities are realized through the ability to seamlessly perform\",\n \"need to be restructured to get back the complex valued eigenvectors. # #\",\n \"eigenvectors) # automatically.** In general, pycroscopy handles compound / complex valued datasets everywhere\",\n \"data_file_path = 'temp_um.h5' # download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5'\",\n \"on our GitHub project page by default. You are encouraged # to download\",\n \"seamlessly perform these analyses on any imaging dataset (regardless of origin, size, complexity)\",\n \"The package used for creating and manipulating HDF5 files: import h5py # Plotting\",\n \"= plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12)\",\n \"sklearn.decomposition import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\",\",\n \"manipulating HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot as plt\",\n \"When using your own data, you can skip this cell and provide the\",\n \"component of the spectral data num_comps = 4 # get the non-negative portion\",\n \"the magnitude of the imaginary component before passing to SVD. # After SVD,\",\n \"component before passing to SVD. # After SVD, the real-valued eigenvectors would need\",\n \"= np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)'\",\n \"ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v\",\n \"as is to SVD would result in # complex valued eigenvectors / endmembers\",\n \"and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group = decomposer.compute() h5_u =\",\n \"work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired\",\n \"frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of\",\n \"# 2. KMeans Clustering # ==================== # # KMeans clustering is a quick\",\n \"optimal labeling # (ie., assignment of each spectra as belonging to the k<sup>th</sup>\",\n \"variance in descending order # * U - corresponding abundance maps # *\",\n \"# clusters (sets) to partition the data into. The algorithm proceeds to find\",\n \"to get back the complex valued eigenvectors. # # **Pycroscopy handles all these\",\n \"abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance\",\n \"\\\"\\\"\\\" ================================================================= Spectral Unmixing ================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging\",\n \"px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering #\",\n \"of the real and imaginary # components. So, the eigenvectors would need to\",\n \"real-valued eigenvectors would need to be treated as the concatenation of the real\",\n \"# get the non-negative portion of the dataset data_mat = np.abs(h5_main) model =\",\n \"px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data currently of shape:', h5_main.shape) x_label\",\n \"V - Eigenvectors sorted by variance in descending order # * U -\",\n \"Complex valued abundance maps are not physical. # Thus, one would need to\",\n \"position in a two # dimensional grid of spatial locations. Thus, this is\",\n \"* **pycroscopy** : Though pycroscopy is mainly used here for plotting purposes only,\",\n \"transformations (both for the source dataset and the eigenvectors) # automatically.** In general,\",\n \"install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for downloading online files: #\",\n \"h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two\",\n \"a two # dimensional matrix in accordance with the pycroscopy data format. #\",\n \"matrix factorization, is a method that is useful towards unmixing of spectral #\",\n \"from __future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy\",\n \"and use your own data instead. # When using your own data, you\",\n \"using your own data, you can skip this cell and provide the path\",\n \"we load some spectral data, and perform basic data analysis, including: ======================================================================================== *\",\n \"is a three dimensional dataset that has been flattened to a two #\",\n \"Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit\",\n \"from advanced atomic force microscopes. In this dataset, a spectra was collected for\",\n \"it is real-valued only. # # One solution is to stack the real\",\n \"NMF only works on non-negative datasets. # For illustrative purposes, we will only\",\n \"the results back into the same dataset among other things \\\"\\\"\\\" # Import\",\n \"USA In this notebook we load some spectral data, and perform basic data\",\n \"estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response']\",\n \"x spectra] in a two dimensional matrix. # # We will be using\",\n \"<NAME> * Institute for Functional Imaging of Materials * Center for Nanophase Materials\",\n \"SVD requires care and caution in interpretation. Nonetheless, it is a good method\",\n \"spectra was collected for each position in a two # dimensional grid of\",\n \"abundance maps # * S - Variance or importance of each of these\",\n \"valued dataset. Passing the complex values as is to SVD would result in\",\n \"these analyses on any imaging dataset (regardless of origin, size, complexity) and storing\",\n \"num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance /\",\n \"# Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity':\",\n \"In general, pycroscopy handles compound / complex valued datasets everywhere possible # #\",\n \"formatted in the same manner of [position x spectra] in a two dimensional\",\n \"the reconstruction of the dataset using only the first N (most significant) components.\",\n \"# dimensional matrix in accordance with the pycroscopy data format. # # Fortunately,\",\n \"evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans clustering is\",\n \"dataset (regardless of origin, size, complexity) and storing the results back into the\",\n \"px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis - vector of\",\n \"So, the eigenvectors would need to be restructured to get back the complex\",\n \"Ridge TN 37831, USA In this notebook we load some spectral data, and\",\n \"the first N (most significant) components. # # SVD results in three matrices:\",\n \"=========================================== # # NMF, or non-negative matrix factorization, is a method that is\",\n \"exponential drop of variance with number of components') # Visualize the eigenvectors: _\",\n \"everywhere possible # # Furthermore, while it is not discussed in this example,\",\n \"# 3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative\",\n \"of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD\",\n \"# SVD results in three matrices: # # * V - Eigenvectors sorted\",\n \"# the same source h5 file including all relevant links to the source\",\n \"suited for data cleaning through # the reconstruction of the dataset using only\",\n \"One solution is to stack the real value followed by the magnitude of\",\n \"import h5py # Plotting and visualization: import matplotlib.pyplot as plt # for downloading\",\n \"Import packages # Ensure that this code works on both python 2 and\",\n \"Oak Ridge National Laboratory, Oak Ridge TN 37831, USA In this notebook we\",\n \"user inputs the number of # clusters (sets) to partition the data into.\",\n \"this code works on both python 2 and python 3 from __future__ import\",\n \"back to # the same source h5 file including all relevant links to\",\n \"# sum of squares is minimized. # # Set the number of clusters\",\n \"abundance maps from # SVD requires care and caution in interpretation. Nonetheless, it\",\n \"Principal Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy,\",\n \"a complex valued dataset. Passing the complex values as is to SVD would\",\n \"# Set the number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main,\",\n \"from # SVD requires care and caution in interpretation. Nonetheless, it is a\",\n \"datasets, NMF only works on non-negative datasets. # For illustrative purposes, we will\",\n \"px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data'])\",\n \"is defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation\",\n \"Jupyter Notebook (button at the bottom of the page) and use your own\",\n \"well as abundance maps. Complex valued abundance maps are not physical. # Thus,\",\n \"as abundance maps. Complex valued abundance maps are not physical. # Thus, one\",\n \"num_components=100) h5_svd_group = decomposer.compute() h5_u = h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S']\",\n \"GitHub project page by default. You are encouraged # to download this document\",\n \"in descending # order of variance or importance. Furthermore, SVD is also very\",\n \"# Furthermore, while it is not discussed in this example, pycroscopy also writes\",\n \"plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF\",\n \"interpretation. Nonetheless, it is a good method for quickly # visualizing the major\",\n \"bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp\",\n \"to seamlessly perform these analyses on any imaging dataset (regardless of origin, size,\",\n \"resultant eigenvectors are sorted in descending # order of variance or importance. Furthermore,\",\n \"imaginary # components. So, the eigenvectors would need to be restructured to get\",\n \"the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None)\",\n \"non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from # SVD\",\n \"Functional Imaging of Materials * Center for Nanophase Materials Sciences Oak Ridge National\",\n \"from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== # # In\",\n \"spectral data num_comps = 4 # get the non-negative portion of the dataset\",\n \"the same dataset among other things \\\"\\\"\\\" # Import packages # Ensure that\",\n \"Plotting and visualization: import matplotlib.pyplot as plt # for downloading files: import wget\",\n \"has been flattened to a two # dimensional matrix in accordance with the\",\n \"are not physical. # Thus, one would need to restructure the data such\",\n \"_ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans\",\n \"or importance of each of these components # # Advantage of pycroscopy: #\",\n \"# components. So, the eigenvectors would need to be restructured to get back\",\n \"components. So, the eigenvectors would need to be restructured to get back the\",\n \"title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical\",\n \"back into the same dataset among other things \\\"\\\"\\\" # Import packages #\",\n \"have been collapsed to one, we need to reshape the abundance maps: abun_maps\",\n \"below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels =\",\n \"#') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### #\",\n \"Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+')\",\n \"machine learning, spectral unmixing algorithms, etc. only accept data that is # formatted\",\n \"algorithms, etc. only accept data that is # formatted in the same manner\",\n \"SVD is an eigenvector decomposition that is defined statistically, and therefore typically produces\",\n \"default. You are encouraged # to download this document as a Jupyter Notebook\",\n \"defined statistically, and therefore typically produces # non-physical eigenvectors. Consequently, the interpretation of\",\n \"values as is to SVD would result in # complex valued eigenvectors /\",\n \"= np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single',\",\n \"/ statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance\",\n \"or non-negative matrix factorization, is a method that is useful towards unmixing of\",\n \"px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14)\",\n \"page) and use your own data instead. # When using your own data,\",\n \"5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components',\",\n \"pip install('pycroscopy') import pycroscopy as px from pycroscopy.viz import cluster_utils ##################################################################################### # The\",\n \"bottom of the page) and use your own data instead. # When using\",\n \"You are encouraged # to download this document as a Jupyter Notebook (button\",\n \"px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp,\",\n \"to one, we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25],\",\n \"not a decomposition method, but a basic clustering method. The user inputs the\",\n \"approximate determination of # factors (matrices) W and H, given a matrix V,\",\n \"# # .. image:: https://upload.wikimedia.org/wikipedia/commons/f/f9/NMF.png # # Unlike SVD and k-Means that can\",\n \"discussed in this example, pycroscopy also writes back the results from SVD back\",\n \"Thus, this is a three dimensional dataset that has been flattened to a\",\n \"that is useful towards unmixing of spectral # data. It only works on\",\n \"eigenvectors would need to be treated as the concatenation of the real and\",\n \"works on both python 2 and python 3 from __future__ import division, print_function,\",\n \"fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the\",\n \"eigenvectors. # # **Pycroscopy handles all these data transformations (both for the source\",\n \"creating and manipulating HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot\",\n \"of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though\",\n \"print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)'\",\n \"complex valued datasets everywhere possible # # Furthermore, while it is not discussed\",\n \"= h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x, y)\",\n \"# # KMeans clustering is a quick and easy method to determine the\",\n \"the bottom of the page) and use your own data instead. # When\",\n \"KMeans Clustering # ==================== # # KMeans clustering is a quick and easy\",\n \"order of variance or importance. Furthermore, SVD is also very well suited for\",\n \"data_file_path data_file_path = 'temp_um.h5' # download the data file from Github: url =\",\n \"* KMeans Clustering * Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites:\",\n \"After SVD, the real-valued eigenvectors would need to be treated as the concatenation\",\n \"to your data using the variable - data_file_path data_file_path = 'temp_um.h5' # download\",\n \"**Pycroscopy handles all these data transformations (both for the source dataset and the\",\n \"parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference\",\n \"np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno',\",\n \"Center for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831,\",\n \"not found. Will install with pip.') import pip install('pycroscopy') import pycroscopy as px\",\n \"##################################################################################### # The Data # ======== # # In this example, we will\",\n \"======== # # In this example, we will work on a **Band Excitation\",\n \"The user inputs the number of # clusters (sets) to partition the data\",\n \"find the optimal labeling # (ie., assignment of each spectra as belonging to\",\n \"types of spectral responses present in the # data. It is not a\",\n \"these components # # Advantage of pycroscopy: # ------------------------ # Notice that we\",\n \"can be applied to complex-valued datasets, NMF only works on non-negative datasets. #\",\n \"Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes.\",\n \"Ensure that this code works on both python 2 and python 3 from\",\n \"In this example, we will work on a **Band Excitation Piezoresponse Force Microscopy\",\n \"* Non-negative Matrix Factorization * Principal Component Analysis Software Prerequisites: ======================= * Standard\",\n \"concatenation of the real and imaginary # components. So, the eigenvectors would need\",\n \"print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some\",\n \"in interpretation. Nonetheless, it is a good method for quickly # visualizing the\",\n \"# data. It is not a decomposition method, but a basic clustering method.\",\n \"except ImportError: print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy') import\",\n \"that we are working with a complex valued dataset. Passing the complex values\",\n \"dimensional grid of spatial locations. Thus, this is a three dimensional dataset that\",\n \"set) such that the within-cluster # sum of squares is minimized. # #\",\n \"will work on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset #\",\n \"a reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units':\",\n \"each spectra as belonging to the k<sup>th</sup> set) such that the within-cluster #\",\n \"h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp,\",\n \"freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0,\",\n \"computation: import numpy as np # The package used for creating and manipulating\",\n \"wget import os # multivariate analysis: from sklearn.cluster import KMeans from sklearn.decomposition import\",\n \"as a Jupyter Notebook (button at the bottom of the page) and use\",\n \"Value Decomposition (SVD) # ===================================== # # SVD is an eigenvector decomposition that\",\n \"Microscopy (BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes. In this\",\n \"import pycroscopy as px except ImportError: print('pycroscopy not found. Will install with pip.')\",\n \"spatial locations. Thus, this is a three dimensional dataset that has been flattened\",\n \"physical. # Thus, one would need to restructure the data such that it\",\n \"partition the data into. The algorithm proceeds to find the optimal labeling #\",\n \"decomposition method, but a basic clustering method. The user inputs the number of\",\n \"Eigenvectors', evenly_spaced=False) ##################################################################################### # 2. KMeans Clustering # ==================== # # KMeans clustering\",\n \"we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols,\",\n \"component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of components') #\",\n \"by approximate determination of # factors (matrices) W and H, given a matrix\",\n \"variance with number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :],\",\n \"of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### #\",\n \"maps from # SVD requires care and caution in interpretation. Nonetheless, it is\",\n \"capabilities are realized through the ability to seamlessly perform these analyses on any\",\n \"abundance maps are not physical. # Thus, one would need to restructure the\",\n \"reference to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'})\",\n \"import NMF import subprocess import sys def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package])\",\n \"Fortunately, all statistical analysis, machine learning, spectral unmixing algorithms, etc. only accept data\",\n \"vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) * 1E-3 print('Data\",\n \"spectra] in a two dimensional matrix. # # We will be using an\",\n \"and k-Means that can be applied to complex-valued datasets, NMF only works on\",\n \"size, complexity) and storing the results back into the same dataset among other\",\n \"================================================================= <NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials * Center\",\n \"advanced atomic force microscopes. In this dataset, a spectra was collected for each\",\n \"wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file)\",\n \"h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] #\",\n \"'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data\",\n \"components # # Advantage of pycroscopy: # ------------------------ # Notice that we are\",\n \"locations. Thus, this is a three dimensional dataset that has been flattened to\",\n \"algorithm proceeds to find the optimal labeling # (ie., assignment of each spectra\",\n \"and provide the path to your data using the variable - data_file_path data_file_path\",\n \"3. Non-negative Matrix Factorization (NMF) # =========================================== # # NMF, or non-negative matrix\",\n \"the complex valued eigenvectors. # # **Pycroscopy handles all these data transformations (both\",\n \"the source dataset and the eigenvectors) # automatically.** In general, pycroscopy handles compound\",\n \"numeric computation: import numpy as np # The package used for creating and\",\n \"project page by default. You are encouraged # to download this document as\",\n \"px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols') # Getting a reference to the main\",\n \"data with positive real values. It operates by approximate determination of # factors\",\n \"eigenvectors and abundance maps from # SVD requires care and caution in interpretation.\",\n \"'temp_um.h5' # download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path =\",\n \"of each spectra as belonging to the k<sup>th</sup> set) such that the within-cluster\",\n \"very well suited for data cleaning through # the reconstruction of the dataset\",\n \"possible # # Furthermore, while it is not discussed in this example, pycroscopy\",\n \"that is # formatted in the same manner of [position x spectra] in\",\n \"eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps from # SVD requires\",\n \"valued datasets everywhere possible # # Furthermore, while it is not discussed in\",\n \"only, it's true capabilities are realized through the ability to seamlessly perform these\",\n \"= h5_svd_group['S'] # Since the two spatial dimensions (x, y) have been collapsed\",\n \"import cluster_utils ##################################################################################### # The Data # ======== # # In this example,\",\n \"data using the variable - data_file_path data_file_path = 'temp_um.h5' # download the data\",\n \"HDF5 files: import h5py # Plotting and visualization: import matplotlib.pyplot as plt #\",\n \"was collected for each position in a two # dimensional grid of spatial\",\n \"dataset. Passing the complex values as is to SVD would result in #\",\n \"well suited for data cleaning through # the reconstruction of the dataset using\",\n \"Oak Ridge TN 37831, USA In this notebook we load some spectral data,\",\n \"# Extracting the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1]\",\n \"# complex valued eigenvectors / endmembers as well as abundance maps. Complex valued\",\n \"this example, pycroscopy also writes back the results from SVD back to #\",\n \"in descending order # * U - corresponding abundance maps # * S\",\n \"grid of spatial locations. Thus, this is a three dimensional dataset that has\",\n \"for creating and manipulating HDF5 files: import h5py # Plotting and visualization: import\",\n \"dimensions (x, y) have been collapsed to one, we need to reshape the\",\n \"storing the results back into the same dataset among other things \\\"\\\"\\\" #\",\n \"# ======== # # In this example, we will work on a **Band\",\n \"sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used here for plotting\",\n \"to SVD. # After SVD, the real-valued eigenvectors would need to be treated\",\n \"Component Analysis Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy,\",\n \"# We will be using an data file available on our GitHub project\",\n \"# * U - corresponding abundance maps # * S - Variance or\",\n \"file available on our GitHub project page by default. You are encouraged #\",\n \"<NAME>, <NAME>, <NAME> * Institute for Functional Imaging of Materials * Center for\",\n \"def install(package): subprocess.call([sys.executable, \\\"-m\\\", \\\"pip\\\", \\\"install\\\", package]) # Package for downloading online files:\",\n \"- Variance or importance of each of these components # # Advantage of\",\n \"eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label, y_label=y_label, title='SVD Eigenvectors', evenly_spaced=False) ##################################################################################### # 2.\",\n \"the k<sup>th</sup> set) such that the within-cluster # sum of squares is minimized.\",\n \"division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as np #\",\n \"this document as a Jupyter Notebook (button at the bottom of the page)\",\n \"complexity) and storing the results back into the same dataset among other things\",\n \"descending order # * U - corresponding abundance maps # * S -\",\n \"page by default. You are encouraged # to download this document as a\",\n \"pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== # # In this\",\n \"h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp =\",\n \"only. # # One solution is to stack the real value followed by\",\n \"# formatted in the same manner of [position x spectra] in a two\",\n \"num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels']\",\n \"caution in interpretation. Nonetheless, it is a good method for quickly # visualizing\",\n \"on data with positive real values. It operates by approximate determination of #\",\n \"# One solution is to stack the real value followed by the magnitude\",\n \"matrix. # # We will be using an data file available on our\",\n \"Advantage of pycroscopy: # ------------------------ # Notice that we are working with a\",\n \"print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows')\",\n \"complex-valued datasets, NMF only works on non-negative datasets. # For illustrative purposes, we\",\n \"ImportError: print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy') import pycroscopy\",\n \"# In this example, we will work on a **Band Excitation Piezoresponse Force\",\n \"the imaginary component before passing to SVD. # After SVD, the real-valued eigenvectors\",\n \"h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp) ##################################################################################### # 3. Non-negative Matrix Factorization (NMF) #\",\n \"with the pycroscopy data format. # # Fortunately, all statistical analysis, machine learning,\",\n \"# Extracting some basic parameters: num_rows = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_rows') num_cols = px.hdf_utils.get_attr(h5_meas_grp, 'grid_num_cols')\",\n \"be applied to complex-valued datasets, NMF only works on non-negative datasets. # For\",\n \"# visualizing the major trends in the dataset since the resultant eigenvectors are\",\n \"h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular\",\n \"of eigenvectors and abundance maps from # SVD requires care and caution in\",\n \"would need to be treated as the concatenation of the real and imaginary\",\n \"microscopes. In this dataset, a spectra was collected for each position in a\",\n \"'V'}) # Extracting the X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main,\",\n \"complex valued eigenvectors / endmembers as well as abundance maps. Complex valued abundance\",\n \"to the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group\",\n \"with number of components') # Visualize the eigenvectors: _ = px.plot_utils.plot_complex_spectra(h5_v[:9, :], x_label=x_label,\",\n \"number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp =\",\n \"is minimized. # # Set the number of clusters below num_clusters = 4\",\n \"analyses on any imaging dataset (regardless of origin, size, complexity) and storing the\",\n \"spatial dimensions (x, y) have been collapsed to one, we need to reshape\",\n \"non-negative matrix factorization, is a method that is useful towards unmixing of spectral\",\n \"# data. It only works on data with positive real values. It operates\",\n \"axis = plt.subplots(figsize=(5.5, 5)) px.plot_utils.plot_line_family(axis, freq_vec, model.components_, label_prefix='NMF Component #') axis.set_xlabel(x_label, fontsize=12) axis.set_ylabel(y_label,\",\n \"acquired from advanced atomic force microscopes. In this dataset, a spectra was collected\",\n \"Software Prerequisites: ======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and\",\n \"the real and imaginary # components. So, the eigenvectors would need to be\",\n \"data that is # formatted in the same manner of [position x spectra]\",\n \"# * V - Eigenvectors sorted by variance in descending order # *\",\n \"treated as the concatenation of the real and imaginary # components. So, the\",\n \"applied to complex-valued datasets, NMF only works on non-negative datasets. # For illustrative\",\n \"axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value) *\",\n \"or importance. Furthermore, SVD is also very well suited for data cleaning through\",\n \"to # the same source h5 file including all relevant links to the\",\n \"color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of each component:\",\n \"non-negative portion of the dataset data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0)\",\n \"variable - data_file_path data_file_path = 'temp_um.h5' # download the data file from Github:\",\n \"a spectra was collected for each position in a two # dimensional grid\",\n \"to download this document as a Jupyter Notebook (button at the bottom of\",\n \"Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance\",\n \"spectra as belonging to the k<sup>th</sup> set) such that the within-cluster # sum\",\n \"NMF, or non-negative matrix factorization, is a method that is useful towards unmixing\",\n \"* 1E-3 print('Data currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label =\",\n \"in the # data. It is not a decomposition method, but a basic\",\n \"SVD back to # the same source h5 file including all relevant links\",\n \"and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used here for\",\n \"back the results from SVD back to # the same source h5 file\",\n \"restructure the data such that it is real-valued only. # # One solution\",\n \"= px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) # Extracting the X axis -\",\n \"and storing the results back into the same dataset among other things \\\"\\\"\\\"\",\n \"typically produces # non-physical eigenvectors. Consequently, the interpretation of eigenvectors and abundance maps\",\n \"quickly # visualizing the major trends in the dataset since the resultant eigenvectors\",\n \"an data file available on our GitHub project page by default. You are\",\n \"of the spectral data num_comps = 4 # get the non-negative portion of\",\n \"your own data instead. # When using your own data, you can skip\",\n \"and imaginary # components. So, the eigenvectors would need to be restructured to\",\n \"with positive real values. It operates by approximate determination of # factors (matrices)\",\n \":25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95)\",\n \"- Eigenvectors sorted by variance in descending order # * U - corresponding\",\n \"------------------------ # Notice that we are working with a complex valued dataset. Passing\",\n \"(button at the bottom of the page) and use your own data instead.\",\n \"import division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as np\",\n \"h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions (x,\",\n \"need to restructure the data such that it is real-valued only. # #\",\n \"on a **Band Excitation Piezoresponse Force Microscopy (BE-PFM)** imaging dataset # acquired from\",\n \"clustering is a quick and easy method to determine the types of spectral\",\n \"to a two # dimensional matrix in accordance with the pycroscopy data format.\",\n \"data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters:\",\n \"the exponential drop of variance with number of components') # Visualize the eigenvectors:\",\n \"data_mat = np.abs(h5_main) model = NMF(n_components=num_comps, init='random', random_state=0) model.fit(data_mat) fig, axis = plt.subplots(figsize=(5.5,\",\n \"numpy, scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly\",\n \"as px except ImportError: print('pycroscopy not found. Will install with pip.') import pip\",\n \"using an data file available on our GitHub project page by default. You\",\n \"to SVD would result in # complex valued eigenvectors / endmembers as well\",\n \"fontsize=12) axis.set_ylabel(y_label, fontsize=12) axis.set_title('NMF Components', fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and\",\n \"used for creating and manipulating HDF5 files: import h5py # Plotting and visualization:\",\n \"fontsize=14) axis.legend(bbox_to_anchor=[1.0, 1.0], fontsize=12) ##################################################################################### # Close and delete the h5_file h5_file.close() os.remove(data_file_path)\",\n \"responses present in the # data. It is not a decomposition method, but\",\n \"for Nanophase Materials Sciences Oak Ridge National Laboratory, Oak Ridge TN 37831, USA\",\n \"======================= * Standard distribution of **Anaconda** (includes numpy, scipy, matplotlib and sci-kit learn)\",\n \"= 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url, data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of\",\n \"abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD Abundance Maps', reverse_dims=True,\",\n \"sklearn.cluster import KMeans from sklearn.decomposition import NMF import subprocess import sys def install(package):\",\n \"in this example, pycroscopy also writes back the results from SVD back to\",\n \"file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000'] # Extracting some basic parameters: num_rows\",\n \"restructured to get back the complex valued eigenvectors. # # **Pycroscopy handles all\",\n \"of squares is minimized. # # Set the number of clusters below num_clusters\",\n \"num_comps = 4 # get the non-negative portion of the dataset data_mat =\",\n \"1. Singular Value Decomposition (SVD) # ===================================== # # SVD is an eigenvector\",\n \"into the same dataset among other things \\\"\\\"\\\" # Import packages # Ensure\",\n \"# ------------------------ # Notice that we are working with a complex valued dataset.\",\n \"real and imaginary # components. So, the eigenvectors would need to be restructured\",\n \"will only take the amplitude component of the spectral data num_comps = 4\",\n \"of the imaginary component before passing to SVD. # After SVD, the real-valued\",\n \"the variance / statistical importance of each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop\",\n \"this notebook we load some spectral data, and perform basic data analysis, including:\",\n \"sorted in descending # order of variance or importance. Furthermore, SVD is also\",\n \"with a complex valued dataset. Passing the complex values as is to SVD\",\n \"handles compound / complex valued datasets everywhere possible # # Furthermore, while it\",\n \"__future__ import division, print_function, absolute_import, unicode_literals # basic numeric computation: import numpy as\",\n \"are working with a complex valued dataset. Passing the complex values as is\",\n \"S - Variance or importance of each of these components # # Advantage\",\n \"# # Set the number of clusters below num_clusters = 4 estimator =\",\n \"of [position x spectra] in a two dimensional matrix. # # We will\",\n \"the source dataset and other ancillary datasets decomposer = px.processing.svd_utils.SVD(h5_main, num_components=100) h5_svd_group =\",\n \"# acquired from advanced atomic force microscopes. In this dataset, a spectra was\",\n \"need to be treated as the concatenation of the real and imaginary #\",\n \"by default. You are encouraged # to download this document as a Jupyter\",\n \"X axis - vector of frequencies h5_spec_vals = px.hdf_utils.get_auxiliary_datasets(h5_main, 'Spectroscopic_Values')[-1] freq_vec = np.squeeze(h5_spec_vals.value)\",\n \"files: import h5py # Plotting and visualization: import matplotlib.pyplot as plt # for\",\n \"px from pycroscopy.viz import cluster_utils ##################################################################################### # The Data # ======== # #\",\n \"/ endmembers as well as abundance maps. Complex valued abundance maps are not\",\n \"data into. The algorithm proceeds to find the optimal labeling # (ie., assignment\",\n \"reverse_dims=True, color_bar_mode='single', cmap='inferno', title_yoffset=0.95) # Visualize the variance / statistical importance of each\",\n \"# # Furthermore, while it is not discussed in this example, pycroscopy also\",\n \"clusters (sets) to partition the data into. The algorithm proceeds to find the\",\n \"eigenvector decomposition that is defined statistically, and therefore typically produces # non-physical eigenvectors.\",\n \"a two dimensional matrix. # # We will be using an data file\",\n \"the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows, num_cols, -1)) px.plot_utils.plot_map_stack(abun_maps, num_comps=9, title='SVD\",\n \"is not a decomposition method, but a basic clustering method. The user inputs\",\n \"# ===================================== # # SVD is an eigenvector decomposition that is defined statistically,\",\n \"force microscopes. In this dataset, a spectra was collected for each position in\",\n \"# # Advantage of pycroscopy: # ------------------------ # Notice that we are working\",\n \"Laboratory, Oak Ridge TN 37831, USA In this notebook we load some spectral\",\n \"on non-negative datasets. # For illustrative purposes, we will only take the amplitude\",\n \"that can be applied to complex-valued datasets, NMF only works on non-negative datasets.\",\n \"= h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------') h5_meas_grp = h5_file['Measurement_000']\",\n \"SVD would result in # complex valued eigenvectors / endmembers as well as\",\n \"==================== # # KMeans clustering is a quick and easy method to determine\",\n \"# Since the two spatial dimensions (x, y) have been collapsed to one,\",\n \"accept data that is # formatted in the same manner of [position x\",\n \"results from SVD back to # the same source h5 file including all\",\n \"will be using an data file available on our GitHub project page by\",\n \"to the main dataset: h5_main = px.PycroDataset(h5_meas_grp['Channel_000/Raw_Data']) px.hdf_utils.write_simple_attrs(h5_main, {'quantity': 'Deflection', 'units': 'V'}) #\",\n \"number of # clusters (sets) to partition the data into. The algorithm proceeds\",\n \"# # SVD is an eigenvector decomposition that is defined statistically, and therefore\",\n \"h5_svd_group['U'] h5_v = h5_svd_group['V'] h5_s = h5_svd_group['S'] # Since the two spatial dimensions\",\n \"is useful towards unmixing of spectral # data. It only works on data\",\n \"the results from SVD back to # the same source h5 file including\",\n \"currently of shape:', h5_main.shape) x_label = 'Frequency (kHz)' y_label = 'Amplitude (a.u.)' #####################################################################################\",\n \"here for plotting purposes only, it's true capabilities are realized through the ability\",\n \"been flattened to a two # dimensional matrix in accordance with the pycroscopy\",\n \"Notebook (button at the bottom of the page) and use your own data\",\n \"# # * V - Eigenvectors sorted by variance in descending order #\",\n \"'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) # ===================================== # #\",\n \"things \\\"\\\"\\\" # Import packages # Ensure that this code works on both\",\n \"matrix in accordance with the pycroscopy data format. # # Fortunately, all statistical\",\n \"W and H, given a matrix V, as shown below # # ..\",\n \"(BE-PFM)** imaging dataset # acquired from advanced atomic force microscopes. In this dataset,\",\n \"Consequently, the interpretation of eigenvectors and abundance maps from # SVD requires care\",\n \"before passing to SVD. # After SVD, the real-valued eigenvectors would need to\",\n \"at the bottom of the page) and use your own data instead. #\",\n \"proceeds to find the optimal labeling # (ie., assignment of each spectra as\",\n \"SVD, the real-valued eigenvectors would need to be treated as the concatenation of\",\n \"scipy, matplotlib and sci-kit learn) * **pycroscopy** : Though pycroscopy is mainly used\",\n \"Set the number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters))\",\n \"abundance maps. Complex valued abundance maps are not physical. # Thus, one would\",\n \"of these components # # Advantage of pycroscopy: # ------------------------ # Notice that\",\n \"the dataset since the resultant eigenvectors are sorted in descending # order of\",\n \"each component: px.plot_utils.plot_scree(h5_s, title='Note the exponential drop of variance with number of components')\",\n \"use your own data instead. # When using your own data, you can\",\n \"= px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp = estimator.compute(h5_main) h5_kmeans_labels = h5_kmeans_grp['Labels'] h5_kmeans_mean_resp = h5_kmeans_grp['Mean_Response'] cluster_utils.plot_cluster_h5_group(h5_kmeans_grp)\",\n \"# # NMF, or non-negative matrix factorization, is a method that is useful\",\n \"# # One solution is to stack the real value followed by the\",\n \"maps are not physical. # Thus, one would need to restructure the data\",\n \"three dimensional dataset that has been flattened to a two # dimensional matrix\",\n \"one, we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:, :25], (num_rows,\",\n \"spectral data, and perform basic data analysis, including: ======================================================================================== * KMeans Clustering *\",\n \"such that the within-cluster # sum of squares is minimized. # # Set\",\n \"and the eigenvectors) # automatically.** In general, pycroscopy handles compound / complex valued\",\n \"be using an data file available on our GitHub project page by default.\",\n \"real value followed by the magnitude of the imaginary component before passing to\",\n \"collapsed to one, we need to reshape the abundance maps: abun_maps = np.reshape(h5_u[:,\",\n \"print('pycroscopy not found. Will install with pip.') import pip install('pycroscopy') import pycroscopy as\",\n \"'Deflection', 'units': 'V'}) # Extracting the X axis - vector of frequencies h5_spec_vals\",\n \"in the same manner of [position x spectra] in a two dimensional matrix.\",\n \"the number of clusters below num_clusters = 4 estimator = px.processing.Cluster(h5_main, KMeans(n_clusters=num_clusters)) h5_kmeans_grp\",\n \"inputs the number of # clusters (sets) to partition the data into. The\",\n \"(kHz)' y_label = 'Amplitude (a.u.)' ##################################################################################### # 1. Singular Value Decomposition (SVD) #\",\n \"# download the data file from Github: url = 'https://raw.githubusercontent.com/pycroscopy/pycroscopy/master/data/BELine_0004.h5' data_file_path = wget.download(url,\",\n \"k-Means that can be applied to complex-valued datasets, NMF only works on non-negative\",\n \"data_file_path, bar=None) h5_file = h5py.File(data_file_path, mode='r+') print('Contents of data file:') print('----------------------') px.hdf_utils.print_tree(h5_file) print('----------------------')\",\n \"to the k<sup>th</sup> set) such that the within-cluster # sum of squares is\",\n \"Though pycroscopy is mainly used here for plotting purposes only, it's true capabilities\",\n \"Factorization (NMF) # =========================================== # # NMF, or non-negative matrix factorization, is a\",\n \"positive real values. It operates by approximate determination of # factors (matrices) W\",\n \"components. # # SVD results in three matrices: # # * V -\",\n \"- corresponding abundance maps # * S - Variance or importance of each\",\n \"of # factors (matrices) W and H, given a matrix V, as shown\"\n]","isConversational":false}}},{"rowIdx":292,"cells":{"ngram":{"kind":"list like","value":["TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file","= get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext,","unittest import TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile","def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url","self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen',","foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True)","content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context","content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content'","urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f:","= urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as","url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile'","{}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True)","= 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext","save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir /","ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url)","from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from","def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response","content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content'","'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext =","url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir","request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt')","url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context)","from unittest import TestCase from unittest.mock import Mock from unittest.mock import patch from","password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir","from pathlib import Path from unittest import TestCase from unittest.mock import Mock from","b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>'","open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url","import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import","content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt')","= get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext =","request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt')","= (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self,","'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name,","'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self):","test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url =","def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response","mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request","self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def","class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def","get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self):","url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar'","get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt')","request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to)","= mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request =","self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def","url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context","'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase):","= 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name","self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext,","mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0]","as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock()","def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def","'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context']","self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class","from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir","= 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context =","download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with","= urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File","{}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True)","/ 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url =","class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def","from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from","f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name =","url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar'","urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url =","name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url)","name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext","'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File","get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile')","urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f:","def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response","root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers)","test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url =","self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value =","context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(),","foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase):","b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0]","mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt'","urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request","def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url","login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with","b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url,","/ 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response","self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen',","self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url)","= get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name,","test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url =","import TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import","from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve()","def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url","class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir,","'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt')","with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self,","/ save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response","mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt'","= b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request =","= Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to","@patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value","url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context","import Path from unittest import TestCase from unittest.mock import Mock from unittest.mock import","patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url","Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir,","pathlib import Path from unittest import TestCase from unittest.mock import Mock from unittest.mock","test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url","context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(),","with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self):","= b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john',","open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen):","def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen',","test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url","ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content'","TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True)","autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value =","unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile","self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def","url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir /","'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File","url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url","mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0]","= Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(","= mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context']","@patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value","= b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir,","shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File","save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response =","from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class","= get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext = get_file_ext_from_url(url) self.assertEqual(ext,","'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context)","= urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as","'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response =","def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value","mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url,","self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock()","setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True)","as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock()","f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value","= 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url =","'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt'","= 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name","'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt'",") request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir /","TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self):","self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class","urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content')","with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self,","self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def","test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self):","= get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name,","'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext =","'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context']","content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' )","= urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File","Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url)","self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def","import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def","download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization',","download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir","= 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context)","foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir =","shutil from pathlib import Path from unittest import TestCase from unittest.mock import Mock","urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content')","ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext = get_file_ext_from_url(url)","/ 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response","url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {})","def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url","request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase):","tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value =","= mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request =","import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import","test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url","= urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as","@patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value","autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value =","autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value =","open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen):","content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to)","get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url)","self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value =","= Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir,","url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile'","save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers,","urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request","get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent /","get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '')","= urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File","'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name =","self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def","= 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {})","TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self):","as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name","test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url =","import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent","urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f:","get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt')","= 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context =","= 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext","'.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self):","import shutil from pathlib import Path from unittest import TestCase from unittest.mock import","download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self):","f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value","name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url)","'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response =","urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context =","import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def","mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers,","'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name =","urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content')","Path from unittest import TestCase from unittest.mock import Mock from unittest.mock import patch","(Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen):","Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to =","unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile","context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(),","'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with","Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url"],"string":"[\n \"TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file\",\n \"= get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext,\",\n \"unittest import TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile\",\n \"def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url\",\n \"self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen',\",\n \"foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True)\",\n \"content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context\",\n \"content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content'\",\n \"urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f:\",\n \"= urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as\",\n \"url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile'\",\n \"{}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True)\",\n \"= 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext\",\n \"save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir /\",\n \"ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url)\",\n \"from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from\",\n \"def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response\",\n \"content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content'\",\n \"'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext =\",\n \"url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir\",\n \"request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt')\",\n \"url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context)\",\n \"from unittest import TestCase from unittest.mock import Mock from unittest.mock import patch from\",\n \"password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir\",\n \"from pathlib import Path from unittest import TestCase from unittest.mock import Mock from\",\n \"b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>'\",\n \"open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url\",\n \"import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import\",\n \"content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt')\",\n \"= get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext =\",\n \"request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt')\",\n \"= (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self,\",\n \"'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name,\",\n \"'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self):\",\n \"test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url =\",\n \"def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response\",\n \"mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request\",\n \"self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def\",\n \"class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def\",\n \"get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self):\",\n \"url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar'\",\n \"get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt')\",\n \"request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to)\",\n \"= mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request =\",\n \"self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def\",\n \"url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context\",\n \"'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase):\",\n \"= 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name\",\n \"self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext,\",\n \"mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0]\",\n \"as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock()\",\n \"def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def\",\n \"'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context']\",\n \"self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class\",\n \"from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir\",\n \"= 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context =\",\n \"download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with\",\n \"= urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File\",\n \"{}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True)\",\n \"/ 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url =\",\n \"class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def\",\n \"from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from\",\n \"f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name =\",\n \"url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar'\",\n \"urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url =\",\n \"name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url)\",\n \"name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext\",\n \"'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File\",\n \"get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile')\",\n \"urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f:\",\n \"def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response\",\n \"root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers)\",\n \"test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url =\",\n \"self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value =\",\n \"context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(),\",\n \"foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase):\",\n \"b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0]\",\n \"mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt'\",\n \"urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request\",\n \"def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url\",\n \"login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with\",\n \"b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url,\",\n \"/ 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response\",\n \"self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen',\",\n \"self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url)\",\n \"= get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name,\",\n \"test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url =\",\n \"import TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import\",\n \"from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve()\",\n \"def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url\",\n \"class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir,\",\n \"'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt')\",\n \"with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self,\",\n \"/ save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response\",\n \"mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt'\",\n \"= b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request =\",\n \"= Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to\",\n \"@patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value\",\n \"url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context\",\n \"import Path from unittest import TestCase from unittest.mock import Mock from unittest.mock import\",\n \"patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url\",\n \"Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir,\",\n \"pathlib import Path from unittest import TestCase from unittest.mock import Mock from unittest.mock\",\n \"test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url\",\n \"context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(),\",\n \"with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self):\",\n \"= b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john',\",\n \"open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen):\",\n \"def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen',\",\n \"test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url\",\n \"ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content'\",\n \"TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True)\",\n \"autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value =\",\n \"unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile\",\n \"self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def\",\n \"url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir /\",\n \"'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File\",\n \"url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url\",\n \"mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0]\",\n \"= Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(\",\n \"= mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context']\",\n \"@patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value\",\n \"= b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir,\",\n \"shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File\",\n \"save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response =\",\n \"from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class\",\n \"= get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext = get_file_ext_from_url(url) self.assertEqual(ext,\",\n \"'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context)\",\n \"= urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as\",\n \"'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response =\",\n \"def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value\",\n \"mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url,\",\n \"self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock()\",\n \"setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True)\",\n \"as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock()\",\n \"f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value\",\n \"= 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url =\",\n \"'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt'\",\n \"= 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name\",\n \"'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt'\",\n \") request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir /\",\n \"TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self):\",\n \"self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class\",\n \"urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content')\",\n \"with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self,\",\n \"self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def\",\n \"test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self):\",\n \"= get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name,\",\n \"'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext =\",\n \"'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context']\",\n \"content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' )\",\n \"= urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File\",\n \"Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url)\",\n \"self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def\",\n \"import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def\",\n \"download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertIn('Authorization',\",\n \"download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir\",\n \"= 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context)\",\n \"foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir =\",\n \"shutil from pathlib import Path from unittest import TestCase from unittest.mock import Mock\",\n \"urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(), 'File content')\",\n \"ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext = get_file_ext_from_url(url)\",\n \"/ 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response\",\n \"url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {})\",\n \"def test_no_ext(self): url = 'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url\",\n \"request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase):\",\n \"tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value =\",\n \"= mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request =\",\n \"import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import\",\n \"test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url\",\n \"= urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as\",\n \"@patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value\",\n \"autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value =\",\n \"autospec=True) def test_only_url(self, urlopen): mock_response = Mock() mock_response.read.return_value = b'File content' urlopen.return_value =\",\n \"open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen):\",\n \"content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to)\",\n \"get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') class TestGetFileExtFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url)\",\n \"self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_with_auth(self, urlopen): mock_response = Mock() mock_response.read.return_value =\",\n \"= Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir,\",\n \"url = 'http://example.com/sub/myfile.txt' ext = get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile'\",\n \"save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers,\",\n \"urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file( root_dir=self.project_dir, url=url, login='john', password='<PASSWORD>' ) request\",\n \"get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent /\",\n \"get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '')\",\n \"= urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File\",\n \"'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' name =\",\n \"self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def\",\n \"= 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {})\",\n \"TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self):\",\n \"as f: self.assertEqual(f.read(), 'File content') class TestGetFileNameFromURL(TestCase): def test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name\",\n \"test_with_ext(self): url = 'http://example.com/sub/myfile.txt' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt') def test_no_ext(self): url =\",\n \"import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent\",\n \"urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f:\",\n \"get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile.txt')\",\n \"= 'http://example.com/myfile.txt' save_to = 'subdir1/subdir2/downloaded.txt' download_file(root_dir=self.project_dir, url=url, save_to=save_to) request = urlopen.call_args.args[0] context =\",\n \"= 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' ext\",\n \"'.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext, '') def test_with_clutter(self):\",\n \"import shutil from pathlib import Path from unittest import TestCase from unittest.mock import\",\n \"download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self):\",\n \"f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response = Mock() mock_response.read.return_value\",\n \"name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name = get_file_name_from_url(url)\",\n \"'myfile.txt') as f: self.assertEqual(f.read(), 'File content') @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_save_to(self, urlopen): mock_response =\",\n \"urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context =\",\n \"import get_file_name_from_url class TestDownloadFile(TestCase): def setUp(self): self.project_dir = (Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def\",\n \"mock_response url = 'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers,\",\n \"'http://example.com/sub/myfile' name = get_file_name_from_url(url) self.assertEqual(name, 'myfile') def test_with_clutter(self): url = 'http://example.com/sub/myfile.txt?param=val&foo=bar' name =\",\n \"urlopen.call_args.kwargs['context'] self.assertIn('Authorization', request.headers) self.assertIsNone(context) with open(self.project_dir / 'myfile.txt') as f: self.assertEqual(f.read(), 'File content')\",\n \"Path from unittest import TestCase from unittest.mock import Mock from unittest.mock import patch\",\n \"(Path(__file__).parent / 'project_dir').resolve() self.project_dir.mkdir(exist_ok=True) def tearDown(self): shutil.rmtree(self.project_dir, ignore_errors=True) @patch('foliant.config.downloadfile.urlopen', autospec=True) def test_only_url(self, urlopen):\",\n \"Mock() mock_response.read.return_value = b'File content' urlopen.return_value = mock_response url = 'http://example.com/myfile.txt' save_to =\",\n \"unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url from foliant.config.downloadfile\",\n \"context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with open(self.project_dir / save_to) as f: self.assertEqual(f.read(),\",\n \"'http://example.com/myfile.txt' download_file(root_dir=self.project_dir, url=url) request = urlopen.call_args.args[0] context = urlopen.call_args.kwargs['context'] self.assertEqual(request.headers, {}) self.assertIsNone(context) with\",\n \"Mock from unittest.mock import patch from foliant.config.downloadfile import download_file from foliant.config.downloadfile import get_file_ext_from_url\"\n]","isConversational":false}}},{"rowIdx":293,"cells":{"ngram":{"kind":"list like","value":["idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send(","チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int:","discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event","「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId()","匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel =","else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 #","初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position)","channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定","711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels","指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position']","= client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel","= discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視","# 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** #","target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] =","positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position']","接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def","= message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id","target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id']","@client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip()","getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # ***********************************************************","str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position):","on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): #","指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧","message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM","target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．'","# ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position':","*********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # ***********************************************************","ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999}","question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得","質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel","# 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id","int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前","client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in","@client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする","# *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels:","import discord client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready():","0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】'","message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id ==","全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換","# チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() ->","# 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async","await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else:","# 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if","dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id)","# 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル","if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() #","for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 #","# 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM #","question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if","== target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id']","質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id =","target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id'] # botとしてDiscordに接続(botのトークンを指定) client.run('605042341715378176')","'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name =","message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: #","起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): #","{'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定","= 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels =","文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する","99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name","-> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** #","= {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 #","id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成","'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) #","on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id","if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] >","async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if","メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信","category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels","if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return","# メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question","if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry,","# positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id)","client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId()","await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel =","カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す","# idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await","all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category)","target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル)","= client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) ==","<gh_stars>0 import discord client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def","getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm()","メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question =","await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: #","== 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n'","指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if","# 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] =","# *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name #","匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす #","+ question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) #","# 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) #","client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name:","'もう1度試してみてください．\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await","= await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' + question)","= client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def","# 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす","target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm =","print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く","0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name","*********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: #","int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id'] # botとしてDiscordに接続(botのトークンを指定)","質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm","target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す","# 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0:","# 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id =","target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for","def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid","= getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await","# カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels #","# 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel","# 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: #","dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\n' '【質問文】' +","client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') #","# 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id':","# 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす","# 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message):","discord client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功')","'【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question)","async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() #","> int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id'] #","target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396","指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0,","# id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() #","all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる","def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'):","繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す","in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 #","def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} #"],"string":"[\n \"idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send(\",\n \"チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int:\",\n \"discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event\",\n \"「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId()\",\n \"匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel =\",\n \"else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 #\",\n \"初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position)\",\n \"channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定\",\n \"711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels\",\n \"指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position']\",\n \"= client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel\",\n \"= discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視\",\n \"# 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** #\",\n \"target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] =\",\n \"positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position']\",\n \"接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def\",\n \"= message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id\",\n \"target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id']\",\n \"@client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip()\",\n \"getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # ***********************************************************\",\n \"str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position):\",\n \"on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): #\",\n \"指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧\",\n \"message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM\",\n \"target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．'\",\n \"# ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position':\",\n \"*********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # ***********************************************************\",\n \"ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999}\",\n \"question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得\",\n \"質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel\",\n \"# 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id\",\n \"int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前\",\n \"client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in\",\n \"@client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする\",\n \"# *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels:\",\n \"import discord client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready():\",\n \"0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】'\",\n \"message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id ==\",\n \"全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換\",\n \"# チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() ->\",\n \"# 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async\",\n \"await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else:\",\n \"# 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if\",\n \"dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id)\",\n \"# 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル\",\n \"if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() #\",\n \"for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 #\",\n \"# 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM #\",\n \"question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if\",\n \"== target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id']\",\n \"質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id =\",\n \"target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id'] # botとしてDiscordに接続(botのトークンを指定) client.run('605042341715378176')\",\n \"'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name =\",\n \"message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: #\",\n \"起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): #\",\n \"{'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定\",\n \"= 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels =\",\n \"文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する\",\n \"99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name\",\n \"-> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} # *********************************************************** #\",\n \"= {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 #\",\n \"id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成\",\n \"'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) #\",\n \"on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id\",\n \"if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] >\",\n \"async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if\",\n \"メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信\",\n \"category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels\",\n \"if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return\",\n \"# メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question\",\n \"if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry,\",\n \"# positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id)\",\n \"client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId()\",\n \"await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel =\",\n \"カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す\",\n \"# idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await\",\n \"all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category)\",\n \"target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル)\",\n \"= client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) ==\",\n \"<gh_stars>0 import discord client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def\",\n \"getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm()\",\n \"メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question =\",\n \"await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: #\",\n \"== 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n'\",\n \"指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if\",\n \"# 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] =\",\n \"# *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name = client.get_channel(category_id).name #\",\n \"匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす #\",\n \"+ question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) #\",\n \"# 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) #\",\n \"client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name:\",\n \"'もう1度試してみてください．\\\\n' '【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await\",\n \"= await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' + question)\",\n \"= client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def\",\n \"# 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす\",\n \"target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm =\",\n \"print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く\",\n \"0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396 # カテゴリidを指定 target_category_name\",\n \"*********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: #\",\n \"int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id'] # botとしてDiscordに接続(botのトークンを指定)\",\n \"質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm\",\n \"target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す\",\n \"# 質問させたいチャンネルのid target_channel_id = getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0:\",\n \"# 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid target_channel_id =\",\n \"target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels # 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for\",\n \"def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() # 質問させたいチャンネルのid\",\n \"= getTargetChannelId() # id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await\",\n \"# カテゴリidを指定 target_category_name = client.get_channel(category_id).name # *********************************************************** # 指定したサーバにある全てのTextチャンネル一覧 all_channels = client.get_guild(602423784946925568).text_channels #\",\n \"# 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel\",\n \"# 全てのTextチャンネルから「指定カテゴリに属する最初のチャンネル」を探す for channel in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: #\",\n \"dm = await message.author.create_dm() # 質問者へDM作成 await dm.send( 'Sorry, メッセージを送信できませんでした．' 'もう1度試してみてください．\\\\n' '【質問文】' +\",\n \"client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功') #\",\n \"# 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id':\",\n \"# 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす\",\n \"# 起動時 @client.event async def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message):\",\n \"discord client = discord.Client() # 接続に使用するオブジェクト # 起動時 @client.event async def on_ready(): print('ログイン成功')\",\n \"'【質問文】' + question) else: # 匿名質問させたいチャンネル target_channel = client.get_channel(target_channel_id) # チャンネルに質問メッセージ送信 await target_channel.send(question)\",\n \"async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'): # 文字から「/box」を抜く question = message.content[len('/box'):].strip() #\",\n \"> int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す return target_channel['id'] #\",\n \"target_channel = {'id': 0, 'position': 99999999} # *********************************************************** # 指定カテゴリ(対象チャンネルが含まれたカテゴリ)の名前 category_id = 711238137598181396\",\n \"指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0,\",\n \"# id=0なら質問者にエラー報告DM # idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() #\",\n \"all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 # 繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる\",\n \"def on_ready(): print('ログイン成功') # メッセージを監視 @client.event async def on_message(message): # 「/box」が頭についたメッセージならオウム返しする if message.content.startswith('/box'):\",\n \"繰り返せば，最後にはpositionが最も小さいチャンネルを代入できる if target_channel['position'] > int(channel.position): target_channel['id'] = int(channel.id) target_channel['position'] = int(channel.position) # 最終的に代入されたidを返す\",\n \"in all_channels: # 指定カテゴリに属する場合だけ対象チャンネル候補とみなす if str(channel.category) == target_category_name: # positionが小さいほうを「より対象チャンネルに近い」として交換 # 初期値はpositionが大きい(99999999)ので，必ず入れ替わる想定 #\",\n \"def getTargetChannelId() -> int: # 質問させたいチャンネル(対象チャンネル) target_channel = {'id': 0, 'position': 99999999} #\"\n]","isConversational":false}}},{"rowIdx":294,"cells":{"ngram":{"kind":"list like","value":["max cell count if any(data_t >= 1): survive_count += 1 if counts_total is","at least 10% of the max cell count if any(data_t >= 1): survive_count","exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders:","== k_abs_t) num = num[0,0] # generate timecourse axes tcax = ax[axnum] #","import numpy as np from fears.utils import results_manager, plotter, dir_manager import os suffix","plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for","cell count if any(data_t >= 1): survive_count += 1 if counts_total is None:","counts_total = data else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale","= ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t =","= results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t","data else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True","= True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug","np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0","counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg =","color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num],","counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t","data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if","# for sim in sim_files: sim = sim_files[k] sim = exp + os.sep","= exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in","for sim in sim_files: sim = sim_files[k] sim = exp + os.sep +","numpy as np from fears.utils import results_manager, plotter, dir_manager import os suffix =","= exp + os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data","counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax,","max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs)","1 if counts_total is None: counts_total = data else: counts_total += data #","sim_files: sim = sim_files[k] sim = exp + os.sep + sim data =","legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg","tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append(","= os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0 while","while k < len(sim_files): # for sim in sim_files: sim = sim_files[k] sim","exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num","sorted(sim_files) survive_count = 0 counts_total = None k=0 while k < len(sim_files): #","0 counts_total = None k=0 while k < len(sim_files): # for sim in","= sorted(sim_files) survive_count = 0 counts_total = None k=0 while k < len(sim_files):","linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data,","data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('')","= exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0]","# data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0:","tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t =","= data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check to see","'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True,","k_abs_t) num = num[0,0] # generate timecourse axes tcax = ax[axnum] # da","is None: counts_total = data else: counts_total += data # data = data/np.max(data)","counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) #","= np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum =","plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 #","the max cell count if any(data_t >= 1): survive_count += 1 if counts_total","> 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total","sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0 while k <","suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims","data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)'","exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop =","= plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[]","matplotlib.pyplot as plt import numpy as np from fears.utils import results_manager, plotter, dir_manager","if any(data_t >= 1): survive_count += 1 if counts_total is None: counts_total =","any(data_t >= 1): survive_count += 1 if counts_total is None: counts_total = data","tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files)",") drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray',","# counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12)","import os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_'","linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg =","num[0,0] # generate timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files","'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False,","color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0:","tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None","as np from fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001'","= 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t =","1): survive_count += 1 if counts_total is None: counts_total = data else: counts_total","generate timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp)","exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs ==","plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file","ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t","grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da =","grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count >","tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count","for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs","from fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder =","data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs","= results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse()","axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t","k < len(sim_files): # for sim in sim_files: sim = sim_files[k] sim =","data = data/np.max(data) data_t = data[-1,:] # check to see if any genotypes","+ '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs","< len(sim_files): # for sim in sim_files: sim = sim_files[k] sim = exp","suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix","exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax =","= data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs =","+= 1 if counts_total is None: counts_total = data else: counts_total += data","= plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7","if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax =","# check to see if any genotypes are at least 10% of the","k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum","= data[-1,:] # check to see if any genotypes are at least 10%","'07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p'","len(sim_files): # for sim in sim_files: sim = sim_files[k] sim = exp +","= data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] #","0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg","timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files","ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count =","exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),))","# da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0","data_t = data[-1,:] # check to see if any genotypes are at least","counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t =","+ suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims =","if counts_total is None: counts_total = data else: counts_total += data # data","labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count","# counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp =","counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc))","sim_files[k] sim = exp + os.sep + sim data = results_manager.get_data(sim) dc =","= data/np.max(data) data_t = data[-1,:] # check to see if any genotypes are","least 10% of the max cell count if any(data_t >= 1): survive_count +=","sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0","else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data","num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes tcax","drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax","= {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax,","} tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1,","drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax )","drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False,","= exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax","= counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg,","alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count #","drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12,","= counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) #","sim in sim_files: sim = sim_files[k] sim = exp + os.sep + sim","counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data =","pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp","dir_manager import os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file =","+ sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data","tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12,","# t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append( tcax )","Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True,","# drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg =","exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells =","= sim_files[k] sim = exp + os.sep + sim data = results_manager.get_data(sim) dc","k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num =","survive_count = 0 counts_total = None k=0 while k < len(sim_files): # for","genotypes are at least 10% of the max cell count if any(data_t >=","= data else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale =","see if any genotypes are at least 10% of the max cell count","survive_count += 1 if counts_total is None: counts_total = data else: counts_total +=","if any genotypes are at least 10% of the max cell count if","= exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax","None: counts_total = data else: counts_total += data # data = data/np.max(data) #","exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2,","exp + os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data =","= '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix +","labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append( tcax","k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) #",") # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg","# exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black',",">= 1): survive_count += 1 if counts_total is None: counts_total = data else:","{'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc,","results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t =","np from fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder","exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] #","data/np.max(data) data_t = data[-1,:] # check to see if any genotypes are at","if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg","= counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t","drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num =","t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append( tcax ) axnum+=1","sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data =","any genotypes are at least 10% of the max cell count if any(data_t",") else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2","fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[]","data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if","n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4))","in sim_files: sim = sim_files[k] sim = exp + os.sep + sim data","k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate","labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax,","= plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4)","ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:]","data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax","results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_' + suffix","0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t)","= data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' }","tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num","survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg =","+ os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1]","check to see if any genotypes are at least 10% of the max","sim = sim_files[k] sim = exp + os.sep + sim data = results_manager.get_data(sim)","= 0 counts_total = None k=0 while k < len(sim_files): # for sim","= 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells","import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_' +","= exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop","counts_total is None: counts_total = data else: counts_total += data # data =","of the max cell count if any(data_t >= 1): survive_count += 1 if","suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells","# data = data/np.max(data) data_t = data[-1,:] # check to see if any","tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) #","tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append(","= float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse","data[-1,:] # check to see if any genotypes are at least 10% of","= np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes tcax =","exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs =","fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_'","= plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24","+ suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file)","'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims","da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total","= 'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info =","results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs","k=0 while k < len(sim_files): # for sim in sim_files: sim = sim_files[k]","counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc)","exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes","data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check to see if","# generate timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files =","None k=0 while k < len(sim_files): # for sim in sim_files: sim =","k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0]","drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2,","counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp","to see if any genotypes are at least 10% of the max cell","data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info","= None k=0 while k < len(sim_files): # for sim in sim_files: sim","data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check to","'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs,","os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' +","os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0 while k","data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7,","'.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs =","in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t)","alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True,","else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 )","drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data,","sim = exp + os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1]","np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes tcax = ax[axnum]","= num[0,0] # generate timecourse axes tcax = ax[axnum] # da = tcax.twinx()","10% of the max cell count if any(data_t >= 1): survive_count += 1","legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da","plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1","= ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count","= tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total =","num = num[0,0] # generate timecourse axes tcax = ax[axnum] # da =","axes tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files =","data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data)","exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax =","drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else:","os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] #","plt import numpy as np from fears.utils import results_manager, plotter, dir_manager import os","data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check","+= data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells","as plt import numpy as np from fears.utils import results_manager, plotter, dir_manager import","plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 )","import matplotlib.pyplot as plt import numpy as np from fears.utils import results_manager, plotter,","k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num],","counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num],","dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:]","($\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray',","= counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg)","counts_total = None k=0 while k < len(sim_files): # for sim in sim_files:","float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes","count if any(data_t >= 1): survive_count += 1 if counts_total is None: counts_total","drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg)","are at least 10% of the max cell count if any(data_t >= 1):","'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder,","True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration"],"string":"[\n \"max cell count if any(data_t >= 1): survive_count += 1 if counts_total is\",\n \"at least 10% of the max cell count if any(data_t >= 1): survive_count\",\n \"exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders:\",\n \"== k_abs_t) num = num[0,0] # generate timecourse axes tcax = ax[axnum] #\",\n \"import numpy as np from fears.utils import results_manager, plotter, dir_manager import os suffix\",\n \"plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for\",\n \"cell count if any(data_t >= 1): survive_count += 1 if counts_total is None:\",\n \"counts_total = data else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale\",\n \"= ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t =\",\n \"= results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t\",\n \"data else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True\",\n \"= True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug\",\n \"np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0\",\n \"counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg =\",\n \"color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num],\",\n \"counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t\",\n \"data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if\",\n \"# for sim in sim_files: sim = sim_files[k] sim = exp + os.sep\",\n \"= exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in\",\n \"for sim in sim_files: sim = sim_files[k] sim = exp + os.sep +\",\n \"numpy as np from fears.utils import results_manager, plotter, dir_manager import os suffix =\",\n \"= exp + os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data\",\n \"counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax,\",\n \"max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs)\",\n \"1 if counts_total is None: counts_total = data else: counts_total += data #\",\n \"sim_files: sim = sim_files[k] sim = exp + os.sep + sim data =\",\n \"legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg\",\n \"tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append(\",\n \"= os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0 while\",\n \"while k < len(sim_files): # for sim in sim_files: sim = sim_files[k] sim\",\n \"exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num\",\n \"sorted(sim_files) survive_count = 0 counts_total = None k=0 while k < len(sim_files): #\",\n \"0 counts_total = None k=0 while k < len(sim_files): # for sim in\",\n \"= sorted(sim_files) survive_count = 0 counts_total = None k=0 while k < len(sim_files):\",\n \"linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data,\",\n \"data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('')\",\n \"= exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0]\",\n \"# data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0:\",\n \"tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t =\",\n \"= data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check to see\",\n \"'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True,\",\n \"k_abs_t) num = num[0,0] # generate timecourse axes tcax = ax[axnum] # da\",\n \"is None: counts_total = data else: counts_total += data # data = data/np.max(data)\",\n \"counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) #\",\n \"= np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum =\",\n \"plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 #\",\n \"the max cell count if any(data_t >= 1): survive_count += 1 if counts_total\",\n \"> 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total\",\n \"sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0 while k <\",\n \"suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims\",\n \"data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)'\",\n \"exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop =\",\n \"= plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[]\",\n \"matplotlib.pyplot as plt import numpy as np from fears.utils import results_manager, plotter, dir_manager\",\n \"if any(data_t >= 1): survive_count += 1 if counts_total is None: counts_total =\",\n \"any(data_t >= 1): survive_count += 1 if counts_total is None: counts_total = data\",\n \"tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files)\",\n \") drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray',\",\n \"# counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12)\",\n \"import os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_'\",\n \"linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg =\",\n \"num[0,0] # generate timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files\",\n \"'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False,\",\n \"color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0:\",\n \"tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None\",\n \"as np from fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001'\",\n \"= 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t =\",\n \"1): survive_count += 1 if counts_total is None: counts_total = data else: counts_total\",\n \"generate timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp)\",\n \"exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs ==\",\n \"plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file\",\n \"ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t\",\n \"grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da =\",\n \"grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count >\",\n \"tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count\",\n \"for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs\",\n \"from fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder =\",\n \"data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs\",\n \"= results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse()\",\n \"axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t\",\n \"k < len(sim_files): # for sim in sim_files: sim = sim_files[k] sim =\",\n \"data = data/np.max(data) data_t = data[-1,:] # check to see if any genotypes\",\n \"+ '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs\",\n \"< len(sim_files): # for sim in sim_files: sim = sim_files[k] sim = exp\",\n \"suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix\",\n \"exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax =\",\n \"= data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs =\",\n \"+= 1 if counts_total is None: counts_total = data else: counts_total += data\",\n \"= plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7\",\n \"if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax =\",\n \"# check to see if any genotypes are at least 10% of the\",\n \"k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum\",\n \"= data[-1,:] # check to see if any genotypes are at least 10%\",\n \"'07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p'\",\n \"len(sim_files): # for sim in sim_files: sim = sim_files[k] sim = exp +\",\n \"= data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] #\",\n \"0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg\",\n \"timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files\",\n \"ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count =\",\n \"exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),))\",\n \"# da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0\",\n \"data_t = data[-1,:] # check to see if any genotypes are at least\",\n \"counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t =\",\n \"+ suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims =\",\n \"if counts_total is None: counts_total = data else: counts_total += data # data\",\n \"labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count\",\n \"# counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp =\",\n \"counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc))\",\n \"sim_files[k] sim = exp + os.sep + sim data = results_manager.get_data(sim) dc =\",\n \"= data/np.max(data) data_t = data[-1,:] # check to see if any genotypes are\",\n \"least 10% of the max cell count if any(data_t >= 1): survive_count +=\",\n \"sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0\",\n \"else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data\",\n \"num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes tcax\",\n \"drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax\",\n \"= {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax,\",\n \"} tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1,\",\n \"drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax )\",\n \"drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False,\",\n \"= exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax\",\n \"= counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg,\",\n \"alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count #\",\n \"drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12,\",\n \"= counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) #\",\n \"sim in sim_files: sim = sim_files[k] sim = exp + os.sep + sim\",\n \"counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data =\",\n \"pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp\",\n \"dir_manager import os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file =\",\n \"+ sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data\",\n \"tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12,\",\n \"# t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append( tcax )\",\n \"Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True,\",\n \"# drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg =\",\n \"exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells =\",\n \"= sim_files[k] sim = exp + os.sep + sim data = results_manager.get_data(sim) dc\",\n \"k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num =\",\n \"survive_count = 0 counts_total = None k=0 while k < len(sim_files): # for\",\n \"genotypes are at least 10% of the max cell count if any(data_t >=\",\n \"= data else: counts_total += data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale =\",\n \"see if any genotypes are at least 10% of the max cell count\",\n \"survive_count += 1 if counts_total is None: counts_total = data else: counts_total +=\",\n \"if any genotypes are at least 10% of the max cell count if\",\n \"= exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax\",\n \"None: counts_total = data else: counts_total += data # data = data/np.max(data) #\",\n \"exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2,\",\n \"exp + os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data =\",\n \"= '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix +\",\n \"labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append( tcax\",\n \"k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) #\",\n \") # drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg\",\n \"# exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black',\",\n \">= 1): survive_count += 1 if counts_total is None: counts_total = data else:\",\n \"{'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc,\",\n \"results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t =\",\n \"np from fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder\",\n \"exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] #\",\n \"data/np.max(data) data_t = data[-1,:] # check to see if any genotypes are at\",\n \"if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg\",\n \"= counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t\",\n \"drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num =\",\n \"t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append( tcax ) axnum+=1\",\n \"sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data =\",\n \"any genotypes are at least 10% of the max cell count if any(data_t\",\n \") else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2\",\n \"fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[]\",\n \"data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if\",\n \"n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4))\",\n \"in sim_files: sim = sim_files[k] sim = exp + os.sep + sim data\",\n \"k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate\",\n \"labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax,\",\n \"= plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4)\",\n \"ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:]\",\n \"data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax\",\n \"results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_' + suffix\",\n \"0 tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t)\",\n \"= data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' }\",\n \"tc_axes=[] drug_axes=[] for exp in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num\",\n \"survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg =\",\n \"+ os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1]\",\n \"check to see if any genotypes are at least 10% of the max\",\n \"sim = sim_files[k] sim = exp + os.sep + sim data = results_manager.get_data(sim)\",\n \"= 0 counts_total = None k=0 while k < len(sim_files): # for sim\",\n \"= 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells\",\n \"import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_' +\",\n \"= exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop\",\n \"counts_total is None: counts_total = data else: counts_total += data # data =\",\n \"of the max cell count if any(data_t >= 1): survive_count += 1 if\",\n \"suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells\",\n \"# data = data/np.max(data) data_t = data[-1,:] # check to see if any\",\n \"tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) #\",\n \"tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc) tc_axes.append(\",\n \"= float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse\",\n \"data[-1,:] # check to see if any genotypes are at least 10% of\",\n \"= np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes tcax =\",\n \"exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs =\",\n \"fears.utils import results_manager, plotter, dir_manager import os suffix = '07212021_0001' data_folder = 'results_'\",\n \"= plotter.plot_timecourse_to_axes(exp_info.populations[num], counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24\",\n \"+ suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file)\",\n \"'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims\",\n \"da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total\",\n \"= 'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info =\",\n \"results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes exp_folders.reverse() k_abs\",\n \"k=0 while k < len(sim_files): # for sim in sim_files: sim = sim_files[k]\",\n \"counts_avg, tcax, labelsize=12) # t = np.arange(len(dc)) # t = t*exp_info.populations[0].timestep_scale/24 # da.plot(t,dc)\",\n \"exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs = exp_info.slopes\",\n \"data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check to see if\",\n \"# generate timecourse axes tcax = ax[axnum] # da = tcax.twinx() sim_files =\",\n \"None k=0 while k < len(sim_files): # for sim in sim_files: sim =\",\n \"k_abs = exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0]\",\n \"drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2,\",\n \"counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp\",\n \"to see if any genotypes are at least 10% of the max cell\",\n \"data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info\",\n \"= None k=0 while k < len(sim_files): # for sim in sim_files: sim\",\n \"data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check to\",\n \"'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs,\",\n \"os suffix = '07212021_0001' data_folder = 'results_' + suffix exp_info_file = 'experiment_info_' +\",\n \"os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total = None k=0 while k\",\n \"data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7,\",\n \"'.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder, exp_info_file) max_cells = exp_info.populations[0].max_cells n_sims = exp_info.n_sims k_abs =\",\n \"in exp_folders: k_abs_t = exp[exp.find('=')+1:] k_abs_t = float(k_abs_t) num = np.argwhere(k_abs == k_abs_t)\",\n \"alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True,\",\n \"else: tcax,da = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 )\",\n \"drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data,\",\n \"sim = exp + os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1]\",\n \"np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes tcax = ax[axnum]\",\n \"= num[0,0] # generate timecourse axes tcax = ax[axnum] # da = tcax.twinx()\",\n \"10% of the max cell count if any(data_t >= 1): survive_count += 1\",\n \"legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else: tcax,da\",\n \"plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, grayscale=True, color='gray', legend_labels=False, linewidth=2, labelsize=12, alpha=0.2 ) # drug_ax.set_ylim(0,10**4) k+=1\",\n \"= ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count\",\n \"= tcax.twinx() sim_files = os.listdir(path=exp) sim_files = sorted(sim_files) survive_count = 0 counts_total =\",\n \"num = num[0,0] # generate timecourse axes tcax = ax[axnum] # da =\",\n \"axes tcax = ax[axnum] # da = tcax.twinx() sim_files = os.listdir(path=exp) sim_files =\",\n \"data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data)\",\n \"exp_info.slopes exp_folders.reverse() k_abs = np.flip(k_abs) fig,ax = plt.subplots(nrows=2,ncols=2,figsize=(4,4)) pop = exp_info.populations[0] ax =\",\n \"drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 ) drug_ax.set_ylabel('') drug_axes.append( drug_ax ) else:\",\n \"os.sep + sim data = results_manager.get_data(sim) dc = data[:,-1] data = data[:,0:-1] #\",\n \"plt import numpy as np from fears.utils import results_manager, plotter, dir_manager import os\",\n \"data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:] # check\",\n \"+= data # data = data/np.max(data) # exp_info.populations[num].counts_log_scale = True data = data/max_cells\",\n \"as plt import numpy as np from fears.utils import results_manager, plotter, dir_manager import\",\n \"plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray', linewidth=1, labelsize=12, alpha=0.7 )\",\n \"import matplotlib.pyplot as plt import numpy as np from fears.utils import results_manager, plotter,\",\n \"k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration ($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num],\",\n \"counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg) tcax,temp = plotter.plot_timecourse_to_axes(exp_info.populations[num],\",\n \"dc = data[:,-1] data = data[:,0:-1] # data = data/np.max(data) data_t = data[-1,:]\",\n \"($\\\\u03BC$M)' } tcax,drug_ax = plotter.plot_timecourse_to_axes(exp_info.populations[num], data, tcax, drug_curve=dc, drug_ax_sci_notation=True, drug_kwargs=drug_kwargs, legend_labels=False, grayscale=True, color='gray',\",\n \"= counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg) # counts_avg = counts_total counts_avg = counts_avg/np.max(counts_avg)\",\n \"counts_total = None k=0 while k < len(sim_files): # for sim in sim_files:\",\n \"float(k_abs_t) num = np.argwhere(k_abs == k_abs_t) num = num[0,0] # generate timecourse axes\",\n \"count if any(data_t >= 1): survive_count += 1 if counts_total is None: counts_total\",\n \"drug_ax.set_ylim(0,10**4) k+=1 if survive_count > 0: counts_avg = counts_total/survive_count # counts_avg = counts_avg/np.max(counts_avg)\",\n \"are at least 10% of the max cell count if any(data_t >= 1):\",\n \"'results_' + suffix exp_info_file = 'experiment_info_' + suffix + '.p' exp_folders,exp_info = results_manager.get_experiment_results(data_folder,\",\n \"True data = data/max_cells if k==0: drug_kwargs = {'alpha':0.7, 'color':'black', 'linewidth':2, 'label':'Drug Concentration\"\n]","isConversational":false}}},{"rowIdx":295,"cells":{"ngram":{"kind":"list like","value":["about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import","i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if","for # which it is fine to always raise an exception. We then","= self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase","renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input","if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for","below self.links_followed = {} # set of links that have ever been followed","(graph, None) def bindinputargs(self, graph, block, inputcells): # Create the initial bindings for","self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved","renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in","exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits =","to the given Variable or Constant.\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg,","type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return","is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom","the known type of a control flow graph variable, defaulting to 'object'.\"\"\" if","= False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block,","if op.opname in ('simple_call', 'call_args'): yield op # some blocks are partially annotated","def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException))","= \" block\"+at opid=\"\" if i is not None: opid = \" op=%d\"","zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph,","= graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference","blocks are partially annotated if op.result.annotation is None: break # ignore the unannotated","source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform from","simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None:","the type inference engine that the situation is currently blocked, and that it","link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if","import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator","The analysis of a block can be in three states: # * block","to the UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise # if the","prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy","which it is fine to always raise an exception. We then # swallow","block.raising_op s_exception = self.get_exception(op) for link in exits: case = link.exitcase if case","is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the","SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) ->","elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out,","saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() #","then # swallow the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container().","= self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s)","will hopefully be solved # later by reflowing). Throw the BlockedInference up to","we must generalize the # input variables). #print '* processblock', block, cells self.annotated[block]","graphs not to annotate again self.blocked_blocks = {} # set of {blocked_block: (graph,","Safety-check the new # annotations that are passed in, and don't annotate the","def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not None: if","newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False","# boom -- in the assert of setbinding() for arg in op.args: if","block have bindings but we # still have to consider all the operations","elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name of","function didn't reach any return statement so far. # (some functions actually never","None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances()","an exception handler. We then only follow the exceptional # branches. exits =","self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy","in sync # with the flow object space. These are the operations for","self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if","exceptional # branches. exits = [link for link in block.exits if link.exitcase is","{}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow from certain positions","raise else: # dead code removal: don't follow all exits if the exitswitch","checkgraph from rpython.translator import simplify, transform from rpython.annotator import model as annmodel, signature","specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy","self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block not","= [block for block, done in self.annotated.items() if done is False] assert len(blocked_blocks)","%s\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence,","self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False # must re-flow","to this func which triggers a reflow whenever the # return block of","self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception","bindinputargs(self, graph, block, inputcells): # Create the initial bindings for the input args","will # always raise an exception which is immediately caught by # an","annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at","if at: blk = \" block\"+at opid=\"\" if i is not None: opid","SomeBool(const=False) ... # boom -- in the assert of setbinding() for arg in","flowin(self, graph, block): try: i = 0 while i < len(block.operations): op =","Throw the BlockedInference up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked:","graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None:","if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in exits: case","else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph,","keep the name of the call operations in sync # with the flow","complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {}","renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell","of the block will # always raise an exception which is immediately caught","with the given input cells.\"\"\" if graph in self.fixed_graphs: # special case for","op # some blocks are partially annotated if op.result.annotation is None: break #","graph-containing-it} self.annotated = {} # set of blocks already seen self.added_blocks = None","given input cells.\"\"\" if graph in self.fixed_graphs: # special case for annotating/rtyping in","difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else:","v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value]))","pending blocks until none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks:","!= oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of","op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise","in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] =","= {} for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] =","self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list)","in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks =","is dict, ( \"%r is not dict. please update %s.__getstate__\" % (key, self.__class__.__name__))","if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value","c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to","in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block]","knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {} for link in","in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert","dict, ( \"%r is not dict. please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key]","newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return","self.break_at: break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s [%s]>\"","try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None):","{}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception,","def binding(self, arg): \"Gives the SomeValue corresponding to the given Variable or Constant.\"","new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if","have bindings but we # still have to consider all the operations in","False in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False","= operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception):","if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy","except Exception as e: # hack for debug tools only if not hasattr(e,","= False in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks =","if op.result.annotation is None: break # ignore the unannotated part #___ simplification (should","call operations in sync # with the flow object space. These are the","v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out)","more general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) ->","the annotation for all exceptions that `operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self)","exits = [link for link in block.exits if link.exitcase is not None] elif","if resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self,","block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert","whereami(self, position_key): graph, block, i = position_key blk = \"\" if block: at","# annotations that are passed in, and don't annotate the old # graph","try: self.added_blocks = {} self.complete() # invoke annotation simplifications for the new blocks","s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in","self.added_blocks = {} self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks)","isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or","new 'cells' with each of the block's existing input # variables. oldcells =","block.at() if at: blk = \" block\"+at opid=\"\" if i is not None:","an exception. We then # swallow the BlockedInference and that's it. # About","input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the specific entry point.\"\"\" assert isinstance(function,","in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs = renaming.get(v,","name of the call operations in sync # with the flow object space.","None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result op =","self.blocked_graphs = {} # set of graphs that have blocked blocks # ---","break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph,","# Add source code to the UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True))","= position_key blk = \"\" if block: at = block.at() if at: blk","simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________","from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator","for block in newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'):","continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference","self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block is left if","try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e:","== len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in","== s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell,","typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out)","or Constant expected, got %r' % (arg,)) def binding(self, arg): \"Gives the SomeValue","self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args,","= policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def","= None # see processblock() below self.links_followed = {} # set of links","= self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally:","entry point into block with the given input cells.\"\"\" if graph in self.fixed_graphs:","SomeValue corresponding to the given Variable or Constant.\" if isinstance(arg, Variable): return arg.annotation","# graph -- it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells):","bind resultcell to op.result def get_exception(self, operation): \"\"\" Return the annotation for all","#___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple):","dead code removal: don't follow all exits if the exitswitch # is known","notify bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value in ret.items():","type(value) is dict, ( \"%r is not dict. please update %s.__getstate__\" % (key,","None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos !=","# processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e:","model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference)","if whence is not None: if callable(whence): def callback(): whence(self, graph) else: callback","the operations in the block. # * self.annotated[block] == graph-containing-block: # analysis done","for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must","it. # About 'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic","op = block.raising_op s_exception = self.get_exception(op) for link in exits: case = link.exitcase","block. # * self.annotated[block] == False: # the input variables of the block","the new 'cells' with each of the block's existing input # variables. oldcells","op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at =","\"Gives the SomeValue corresponding to the given Variable or Constant.\" if isinstance(arg, Variable):","renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint","BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return else: # other","unannotated part #___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None):","s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self):","\"knowntypedata\", {}) else: knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase,","that!\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and","\"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self,","#print '* processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks: del","link, {}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc =","position else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type))","op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops: continue","elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key","pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key,","not in attrs: assert type(value) is dict, ( \"%r is not dict. please","key, value in ret.items(): if key not in attrs: assert type(value) is dict,","'?' if pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg))","case = link.exitcase if case is None: self.follow_link(graph, link, {}) continue if s_exception","'__annotator_block', block) raise # The dict 'added_blocks' is used by rpython.annlowlevel to #","link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in","link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out","invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved","callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def callback():","annmodel.AnnotatorError as e: # note that UnionError is a subclass e.source = gather_error(self,","difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class","self.bookkeeper = bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed notify bookkeeper","only follow the exceptional # branches. exits = [link for link in block.exits","annotate again self.blocked_blocks = {} # set of {blocked_block: (graph, index)} # ---","op.opname in ('simple_call', 'call_args'): yield op # some blocks are partially annotated if","extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs =","if i is not None: opid = \" op=%d\" % i return repr(graph)","dictionary of call # points to this func which triggers a reflow whenever","for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code","= AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description in doc/translation.txt.\"\"\" def","graph, block, i) raise else: # dead code removal: don't follow all exits","part #___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): #","try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False # failed, hopefully","newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out,","s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out)","= {} self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally:","do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index","self.annotation(arg) if s_arg is None: raise KeyError return s_arg def typeannotation(self, t): return","False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells):","getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {} for link in exits: constraints","a control flow graph variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value)","t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old","\"\"\"Register an entry point into block with the given input cells.\"\"\" if graph","% (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface __________________","try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?':","exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch)","( \"%r is not dict. please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] =","oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of =","that it should try to progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator","have blocked blocks # --- end of debugging information --- self.frozen = False","Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant","# always raise an exception which is immediately caught by # an exception","always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key","newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i = position_key blk","opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None","i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError","block will # always raise an exception which is immediately caught by #","zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out in","op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell","if not self.break_at: break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at","to # detect which are the new blocks that annotating an additional #","e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except","op): # let's be careful about avoiding propagated SomeImpossibleValues # to enter an","changed, we must redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions)","exception. We then # swallow the BlockedInference and that's it. # About 'next':","this func which triggers a reflow whenever the # return block of this","None: if callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback] =","link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints:","if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e:","BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable):","the (current) return value v = graph.getreturnvar() try: return self.binding(v) except KeyError: #","e: # Add source code to the UnionError e.source = '\\n'.join(source_lines(graph, block, None,","simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self,","sure that the return variables of all graphs is annotated if self.added_blocks is","def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process","be in three states: # * block not in self.annotated: # never seen","reflowing). Throw the BlockedInference up to # processblock(). e.opindex = i raise except","def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except","s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old =","consider all the operations in the block. # * self.annotated[block] == graph-containing-block: #","convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations","flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register an entry","block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): #","of all graphs is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block]","list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells):","op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if e.op","def flowin(self, graph, block): try: i = 0 while i < len(block.operations): op","= self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy =","self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper =","= annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex = opindex","# set of blocks already seen self.added_blocks = None # see processblock() below","{} # set of graphs not to annotate again self.blocked_blocks = {} #","recorded for debugging --- self.blocked_graphs = {} # set of graphs that have","self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs())","and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s","variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable","in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in","block, cells): \"\"\"Register an entry point into block with the given input cells.\"\"\"","The dict 'added_blocks' is used by rpython.annlowlevel to # detect which are the","already seen self.added_blocks = None # see processblock() below self.links_followed = {} #","triggers a reflow whenever the # return block of this graph has been","\" op=%d\" % i return repr(graph) + blk + opid def flowin(self, graph,","absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype","complete(self): \"\"\"Process pending blocks until none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if","self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False # must","= True blocked_blocks = [block for block, done in self.annotated.items() if done is","translator.annotator = self self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it}","= defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in","graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is","We then only follow the exceptional # branches. exits = [link for link","is not None: if not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" % (s_value,","def __repr__(self): if not self.break_at: break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at) return","newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op #","the case where the last operation of the block will # always raise","= ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph =","later by reflowing). Throw the BlockedInference up to # processblock(). e.opindex = i","a subclass e.source = gather_error(self, graph, block, i) raise else: # dead code","except AttributeError: pos = '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/","{} # set of graphs that have blocked blocks # --- end of","policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells =","# XXX warning, keep the name of the call operations in sync #","whence is not None: if callable(whence): def callback(): whence(self, graph) else: callback =","graph, tag) # self.notify[graph.returnblock] is a dictionary of call # points to this","None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name","[] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out","= self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def callback(): whence(self,","is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known","the block will # always raise an exception which is immediately caught by","%s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value","for debugging --- self.blocked_graphs = {} # set of graphs that have blocked","to annotate again self.blocked_blocks = {} # set of {blocked_block: (graph, index)} #","tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of","all exceptions that `operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is","= [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type","block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the","AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model","AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description in doc/translation.txt.\"\"\" def __init__(self,","ret[key] = {} return ret #___ convenience high-level interface __________________ def build_types(self, function,","`operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception))","# recursively proceed until no more pending block is left if complete_now: self.complete()","% (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def","self.op = op self.opindex = opindex def __repr__(self): if not self.break_at: break_at =","s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits if","SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation is","arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v = graph.getreturnvar()","s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i =","block.raising_op: # this is the case where the last operation of the block","Exception as e: # hack for debug tools only if not hasattr(e, '__annotator_block'):","the name of the call operations in sync # with the flow object","= typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const","block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block]","+ opid def flowin(self, graph, block): try: i = 0 while i <","at: blk = \" block\"+at opid=\"\" if i is not None: opid =","args of a block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs,","until we find we must generalize the # input variables). #print '* processblock',","ignore links that try to pass impossible values if s_out == s_ImpossibleValue: ignore_link","renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is","block, i = position_key blk = \"\" if block: at = block.at() if","= defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args:","link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False","to self.addpendingblock(). # The analysis of a block can be in three states:","the merged cells changed, we must redo the analysis if unions != oldcells:","call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated # all","self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations ______ def consider_op(self,","= SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc)","graph, block, i = position_key blk = \"\" if block: at = block.at()","annotations about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy","main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy):","= \"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s [%s]>\" %(break_at, self.op)","else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s [%s]>\" %(break_at, self.op) __str__ =","arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\"%s does not contain","self.links_followed = {} # set of links that have ever been followed self.notify","complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known type of a","None) def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with each","self.fixed_graphs = {} # set of graphs not to annotate again self.blocked_blocks =","in the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise","SomeValue corresponding to the given Variable or Constant.\" s_arg = self.annotation(arg) if s_arg","block, cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph,","def annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy","annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None): if pos","additional # small helper creates. if self.added_blocks is not None: self.added_blocks[block] = True","else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata =","policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function,","{positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to annotate again self.blocked_blocks","annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op","arg, s_value): s_old = arg.annotation if s_old is not None: if not s_value.contains(s_old):","not None: if callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback]","block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for","exits = [link for link in exits if link.exitcase == s_exitswitch.const] if block.canraise:","def bindinputargs(self, graph, block, inputcells): # Create the initial bindings for the input","nbarg # wrong number of args # register the entry point self.addpendinggraph(flowgraph, inputcells)","self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper","desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s)","return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try:","in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant):","annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def","def whereami(self, position_key): graph, block, i = position_key blk = \"\" if block:","debugging information --- self.frozen = False if policy is None: from rpython.annotator.policy import","new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result =","operations in sync # with the flow object space. These are the operations","ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock,","self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None:","never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block,","v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v]","= self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def","( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return","# never seen the block. # * self.annotated[block] == False: # the input","= True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception","None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) #","'next'): # XXX warning, keep the name of the call operations in sync","__________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the specific","for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool()","new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if e.op is block.raising_op:","signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import","then only follow the exceptional # branches. exits = [link for link in","seen the block. # * self.annotated[block] == False: # the input variables of","self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated","newblocks = self.annotated # all of them for block in newblocks: for op","in ('simple_call', 'call_args'): yield op # some blocks are partially annotated if op.result.annotation","graph = self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph)","* self.annotated[block] == graph-containing-block: # analysis done (at least until we find we","args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy()","policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() #","= {} # map {block: graph-containing-it} self.annotated = {} # set of blocks","so far. # (some functions actually never do, they always raise exceptions) return","in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out ==","of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph,","= {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s","the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return else: #","in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None) def","self.opindex = opindex def __repr__(self): if not self.break_at: break_at = \"?\" else: break_at","ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} #","parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call # points","def validate(self): \"\"\"Check that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg):","annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value","links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value in","the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block","else: self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper =","if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else:","recursively proceed until no more pending block is left if complete_now: self.complete() return","translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {} #","reach any return statement so far. # (some functions actually never do, they","= s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const","certain positions when this block is done for callback in self.notify[block]: if isinstance(callback,","\"\"\"Check that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the","s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None): if pos is","more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable):","# the function didn't reach any return statement so far. # (some functions","must redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self,","= True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self)","AttributeError: pos = '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\"","cells): \"\"\"Register an entry point into block with the given input cells.\"\"\" if","with each of the block's existing input # variables. oldcells = [self.binding(a) for","import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls","\"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs","self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not","have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {}","if pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___","# The analysis of a block can be in three states: # *","= [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for","SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log =","(types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming =","= graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def","len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] =","variables of the block have bindings but we # still have to consider","# register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more","True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure that","of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values():","in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False #","isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return","s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in exits:","link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception","annotating/rtyping in several phases: calling # a graph that has already been rtyped.","s_out = pair(s_out, s_constraint).improve() # ignore links that try to pass impossible values","arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got","self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?': pos = self.whereami(pos)","hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {}","not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen assert","rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable,","\"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw)","# swallow the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return","False inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs):","already been rtyped. Safety-check the new # annotations that are passed in, and","v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation results are","graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks","else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while","interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph,","build annotations about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from","block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for graph","the new # annotations that are passed in, and don't annotate the old","rpython.annlowlevel to # detect which are the new blocks that annotating an additional","find we must generalize the # input variables). #print '* processblock', block, cells","Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits","pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if","None: if not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\"","is None: break # ignore the unannotated part #___ simplification (should be moved","rpython.annotator import model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance,","flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function)","case where the last operation of the block will # always raise an","'\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells changed, we must","args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved =","flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the","% (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells):","zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to the UnionError e.source","self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if","We then # swallow the BlockedInference and that's it. # About 'next': see","is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul","for link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op","from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object):","if e.op is block.raising_op: # this is the case where the last operation","follow the exceptional # branches. exits = [link for link in block.exits if","__init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError:","graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type))","typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if","in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError","UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells","# input variables). #print '* processblock', block, cells self.annotated[block] = graph if block","point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block is left","== s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in","is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case =","elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object","other cases are problematic (but will hopefully be solved # later by reflowing).","self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self,","input variables of the block have bindings but we # still have to","resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell ==","test_annotate_iter_empty_container(). return else: # other cases are problematic (but will hopefully be solved","removal: don't follow all exits if the exitswitch # is known exits =","update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level","set of graphs that have blocked blocks # --- end of debugging information","is block.raising_op: # this is the case where the last operation of the","are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue corresponding to the given","for link in exits: case = link.exitcase if case is None: self.follow_link(graph, link,","for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some","{} for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True","# invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks =","build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg #","op=%d\" % i return repr(graph) + blk + opid def flowin(self, graph, block):","of {blocked_block: (graph, index)} # --- the following information is recorded for debugging","= [link for link in block.exits if link.exitcase is not None] elif e.op.opname","blocks that annotating an additional # small helper creates. if self.added_blocks is not","consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues # to enter","set of graphs not to annotate again self.blocked_blocks = {} # set of","self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None) def","graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link =","# interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator =","= s_value def warning(self, msg, pos=None): if pos is None: try: pos =","== False: # the input variables of the block have bindings but we","e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None),","isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell","self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() # invoke annotation","isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def","e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note","s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch,","of links that have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}}","variables). #print '* processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks:","Constant.\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise","XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if","None: newblocks = self.annotated # all of them for block in newblocks: for","-- it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg =","... # boom -- in the assert of setbinding() for arg in op.args:","of blocks already seen self.added_blocks = None # see processblock() below self.links_followed =","of call # points to this func which triggers a reflow whenever the","= newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i = position_key","is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell","self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False","none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished","input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s,","(but will hopefully be solved # later by reflowing). Throw the BlockedInference up","the input variables of the block have bindings but we # still have","s_arg is None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper)","the given Variable or Constant.\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant):","operation of the block will # always raise an exception which is immediately","= difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {})","far. # (some functions actually never do, they always raise exceptions) return s_ImpossibleValue","= {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not","Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation): \"\"\" Return","s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot","BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list) for v_out, v_input","newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all","%s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface","self.fixed_graphs: # special case for annotating/rtyping in several phases: calling # a graph","reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks =","TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {} # map {block:","policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications for the new","op; the latter can result in violations of the # more general results","graphs that have blocked blocks # --- end of debugging information --- self.frozen","if s_old is not None: if not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\"","s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if","raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None: resultcell =","block with the given input cells.\"\"\" if graph in self.fixed_graphs: # special case","= self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the","least until we find we must generalize the # input variables). #print '*","while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure","is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise","__repr__(self): if not self.break_at: break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference","link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type","try to pass impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out","is None: newblocks = self.annotated # all of them for block in newblocks:","\"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments","else: # other cases are problematic (but will hopefully be solved # later","s_old is not None: if not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" %","e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name of the","by reflowing). Throw the BlockedInference up to # processblock(). e.opindex = i raise","raise TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self, arg): \"Gives","done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a","self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations","simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications","= AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function,","len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args # register the","self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks until none is left.\"\"\" while","in three states: # * block not in self.annotated: # never seen the","input # variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions =","no more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self,","link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const =","to op.result def get_exception(self, operation): \"\"\" Return the annotation for all exceptions that","resultcell) # bind resultcell to op.result def get_exception(self, operation): \"\"\" Return the annotation","a block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a,","of the block's existing input # variables. oldcells = [self.binding(a) for a in","gather_error(self, graph, block, i) raise else: # dead code removal: don't follow all","self.follow_link(graph, link, constraints) if block in self.notify: # reflow from certain positions when","if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs","small helper creates. if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self,","self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave()","self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self,","re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): # Create the","v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const","analysis of a block can be in three states: # * block not","v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if","inputcells) # get the (current) return value v = graph.getreturnvar() try: return self.binding(v)","= format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v =","self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register an entry point into","cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell","for the input args of a block. assert len(block.inputargs) == len(inputcells) for a,","renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const","always raise an exception. We then # swallow the BlockedInference and that's it.","value in ret.items(): if key not in attrs: assert type(value) is dict, (","return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' % (arg,)) def","translator is None: # interface for tests from rpython.translator.translator import TranslationContext translator =","log.WARNING(\"%s does not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert","long=True)) raise # if the merged cells changed, we must redo the analysis","in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects","type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list)","simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs","bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated","link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out =","finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg =","else: raise TypeError(\"Variable or Constant instance expected, \" \"got %r\" % (variable,)) def","# (some functions actually never do, they always raise exceptions) return s_ImpossibleValue def","Constant instance expected, \" \"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list","assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation):","raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph,","self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def","== graph-containing-block: # analysis done (at least until we find we must generalize","type inference engine that the situation is currently blocked, and that it should","if graph in self.fixed_graphs: # special case for annotating/rtyping in several phases: calling","self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph,","= '\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells changed, we","self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks:","new blocks that annotating an additional # small helper creates. if self.added_blocks is","links that have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs","c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to the","self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc","op.result def get_exception(self, operation): \"\"\" Return the annotation for all exceptions that `operation`","= [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul)","block, inputcells): # Merge the new 'cells' with each of the block's existing","or Constant.\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else:","or Constant.\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError return s_arg","self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call # points to","is a position else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase,","# Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs","self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks","annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex = opindex def","the SomeValue corresponding to the given Variable or Constant.\" if isinstance(arg, Variable): return","is None: graphs = self.translator.graphs else: graphs = {} for block in block_subset:","op, -1) resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif","flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph,","graph in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def","not in self.annotated: # never seen the block. # * self.annotated[block] == False:","'call_args'): yield op # some blocks are partially annotated if op.result.annotation is None:","if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link","if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None)","whenever the # return block of this graph has been analysed. callpositions =","# small helper creates. if self.added_blocks is not None: self.added_blocks[block] = True def","for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell =","_____________________ def processblock(self, graph, block): # Important: this is not called recursively. #","whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block,","we # still have to consider all the operations in the block. #","hopefully be solved # later by reflowing). Throw the BlockedInference up to #","+= 1 except BlockedInference as e: if e.op is block.raising_op: # this is","[self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs","graphs = {} for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph]","s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg,","False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else:","from rpython.translator import simplify, transform from rpython.annotator import model as annmodel, signature from","assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for","return value v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the function","return except annmodel.AnnotatorError as e: # note that UnionError is a subclass e.source","analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def","detect which are the new blocks that annotating an additional # small helper","About 'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic (but will","try to progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator = annotator try:","rpython.rtyper.extfuncregistry # has side effects if translator is None: # interface for tests","def annotation(self, arg): \"Gives the SomeValue corresponding to the given Variable or Constant.\"","if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is","signals the type inference engine that the situation is currently blocked, and that","AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper","1 except BlockedInference as e: if e.op is block.raising_op: # this is the","s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old))","s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation,","= knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow from","calls to self.addpendingblock(). # The analysis of a block can be in three","known type of a control flow graph variable, defaulting to 'object'.\"\"\" if isinstance(variable,","boom -- in the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg),","result in violations of the # more general results invariant: e.g. if SomeImpossibleValue","dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all of them","inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self,","setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell","if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s,","new # annotations that are passed in, and don't annotate the old #","if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore","def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator","given Variable or Constant.\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return","block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for","blocks already seen self.added_blocks = None # see processblock() below self.links_followed = {}","= {} for v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v","graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks until none is","e.op is block.raising_op: # this is the case where the last operation of","ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively","# special case for annotating/rtyping in several phases: calling # a graph that","not to annotate again self.blocked_blocks = {} # set of {blocked_block: (graph, index)}","the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells,","main_entry_point=False): \"\"\"Recursively build annotations about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix","see test_annotate_iter_empty_container(). return else: # other cases are problematic (but will hopefully be","annotation(self, arg): \"Gives the SomeValue corresponding to the given Variable or Constant.\" if","continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case)","Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype","RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None,","= '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos,","last operation of the block will # always raise an exception which is","rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from","False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text)","annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for block in self.added_blocks]","block) except BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block]","register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending","self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self, graph, link, constraints):","block): try: i = 0 while i < len(block.operations): op = block.operations[i] with","class BlockedInference(Exception): \"\"\"This exception signals the type inference engine that the situation is","block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs = {}","renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v,","exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op)","that the return variables of all graphs is annotated if self.added_blocks is not","else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and","inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert","= bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen","self.break_at = None self.op = op self.opindex = opindex def __repr__(self): if not","# * self.annotated[block] == graph-containing-block: # analysis done (at least until we find","block, None, long=True)) raise # if the merged cells changed, we must redo","for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out =","if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self,","rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is","\"Gives the SomeValue corresponding to the given Variable or Constant.\" s_arg = self.annotation(arg)","flow graph variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable,","them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph]","func which triggers a reflow whenever the # return block of this graph","graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in","= gather_error(self, graph, block, i) raise else: # dead code removal: don't follow","None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom --","and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if","self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications","nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args #","is None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos","v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type,","ignore_link = False inputs_s = [] renaming = defaultdict(list) for v_out, v_input in","cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self,","a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph,","self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure that the","{blocked_block: (graph, index)} # --- the following information is recorded for debugging ---","return ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False):","else: raise TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self, arg):","link, constraints) if block in self.notify: # reflow from certain positions when this","cells.\"\"\" if graph in self.fixed_graphs: # special case for annotating/rtyping in several phases:","\"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for","newblocks is None: newblocks = self.annotated # all of them for block in","self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue corresponding to the given Variable or","# self.notify[graph.returnblock] is a dictionary of call # points to this func which","may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else:","while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops =","debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The","{} for v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v in","general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool","arguments and set their type args_s = [self.typeannotation(t) for t in input_arg_types] #","not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False","isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation): \"\"\"","# Create the initial bindings for the input args of a block. assert","desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy","self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): # Create the initial","not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]:","return variables of all graphs is annotated if self.added_blocks is not None: newgraphs","BlockedInference up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except","block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None)","succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to","added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value in ret.items(): if key not in","# branches. exits = [link for link in block.exits if link.exitcase is not","isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming","operations ______ def consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues","s_value def warning(self, msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key","0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops","= block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link","input cells.\"\"\" if graph in self.fixed_graphs: # special case for annotating/rtyping in several","is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation results are valid\"\"\"","# if the merged cells changed, we must redo the analysis if unions","processblock() below self.links_followed = {} # set of links that have ever been","= whence callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock,","still have to consider all the operations in the block. # * self.annotated[block]","= self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve()","branches. exits = [link for link in block.exits if link.exitcase is not None]","interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the","break # ignore the unannotated part #___ simplification (should be moved elsewhere?) _______","constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try to pass impossible","return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old","# still have to consider all the operations in the block. # *","mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with each of the","propagated SomeImpossibleValues # to enter an op; the latter can result in violations","assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value,","-> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in","is not None: if callable(whence): def callback(): whence(self, graph) else: callback = whence","op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable)","= i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that","issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list) for v_out,","map {block: graph-containing-it} self.annotated = {} # set of blocks already seen self.added_blocks","v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out]","graph in self.fixed_graphs: # special case for annotating/rtyping in several phases: calling #","the last operation of the block will # always raise an exception which","SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in the","= {} # set of graphs that have blocked blocks # --- end","build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the specific entry point.\"\"\"","s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata","(isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming","v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if","'call_args', 'next'): # XXX warning, keep the name of the call operations in","resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed assert","True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the","return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected,","only issue calls to self.addpendingblock(). # The analysis of a block can be","sync # with the flow object space. These are the operations for #","calling # a graph that has already been rtyped. Safety-check the new #","flowing annotations in blocks _____________________ def processblock(self, graph, block): # Important: this is","rpython.translator import simplify, transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model","inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index","in ret.items(): if key not in attrs: assert type(value) is dict, ( \"%r","in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant():","into block with the given input cells.\"\"\" if graph in self.fixed_graphs: # special","for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise #","graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation","must generalize the # input variables). #print '* processblock', block, cells self.annotated[block] =","it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a)","s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of","v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of)","log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph,","def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the specific entry","BlockedInference(Exception): \"\"\"This exception signals the type inference engine that the situation is currently","the block's existing input # variables. oldcells = [self.binding(a) for a in block.inputargs]","analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if","to the given Variable or Constant.\" s_arg = self.annotation(arg) if s_arg is None:","variable): \"\"\"Return the known type of a control flow graph variable, defaulting to","an op; the latter can result in violations of the # more general","return object else: raise TypeError(\"Variable or Constant instance expected, \" \"got %r\" %","special case for annotating/rtyping in several phases: calling # a graph that has","# points to this func which triggers a reflow whenever the # return","self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except","passed in, and don't annotate the old # graph -- it's already low-level","self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy =","corresponding to the given Variable or Constant.\" if isinstance(arg, Variable): return arg.annotation elif","return statement so far. # (some functions actually never do, they always raise","inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None)","left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make","# detect which are the new blocks that annotating an additional # small","entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block is","value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs","from __future__ import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import","is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \"\"\"translator","a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin.","return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def","bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy","a dictionary of call # points to this func which triggers a reflow","BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue","corresponding to the given Variable or Constant.\" s_arg = self.annotation(arg) if s_arg is","a reflow whenever the # return block of this graph has been analysed.","if new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result","self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks until","the return variables of all graphs is annotated if self.added_blocks is not None:","of a block can be in three states: # * block not in","len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops","inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s,","self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata =","block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks","inputcells): # Merge the new 'cells' with each of the block's existing input","whence callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells)","been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence):","to consider all the operations in the block. # * self.annotated[block] == graph-containing-block:","the # more general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue,","Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for","raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg,","if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is","if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self,","caught by # an exception handler. We then only follow the exceptional #","assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block]","graph assert block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] =","# return block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {})","True blocked_blocks = [block for block, done in self.annotated.items() if done is False]","args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = (","return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type","parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock]","violations of the # more general results invariant: e.g. if SomeImpossibleValue enters is_","(at least until we find we must generalize the # input variables). #print","self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback() def","# --- the following information is recorded for debugging --- self.blocked_graphs = {}","been rtyped. Safety-check the new # annotations that are passed in, and don't","raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation is None:","we find we must generalize the # input variables). #print '* processblock', block,","the following information is recorded for debugging --- self.blocked_graphs = {} # set","return else: # other cases are problematic (but will hopefully be solved #","known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits","#___ creating the annotations based on operations ______ def consider_op(self, op): # let's","-1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result,","that has already been rtyped. Safety-check the new # annotations that are passed","where the last operation of the block will # always raise an exception","solved # later by reflowing). Throw the BlockedInference up to # processblock(). e.opindex","assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out","for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block","can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class","expected, \" \"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\"","variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for","= {} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints)","oldcells = [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1,","('simple_call', 'call_args'): yield op # some blocks are partially annotated if op.result.annotation is","for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for","self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] =","exception signals the type inference engine that the situation is currently blocked, and","link in exits: case = link.exitcase if case is None: self.follow_link(graph, link, {})","{} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if","Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' % (arg,))","block, i) raise else: # dead code removal: don't follow all exits if","fine to always raise an exception. We then # swallow the BlockedInference and","# is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... #","the operations for # which it is fine to always raise an exception.","= policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications for the","else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the type inference engine that","flow object space. These are the operations for # which it is fine","self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block","the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self,","annotation for all exceptions that `operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if","blocked, and that it should try to progress elsewhere.\"\"\" def __init__(self, annotator, op,","else: knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph,","= block.at() if at: blk = \" block\"+at opid=\"\" if i is not","immediately caught by # an exception handler. We then only follow the exceptional","< len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if","block) raise # The dict 'added_blocks' is used by rpython.annlowlevel to # detect","which triggers a reflow whenever the # return block of this graph has","newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for","progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at =","newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value]","block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs","( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import","s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs = renaming.get(v, [])","s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out,","self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex =","(graph, index)} # --- the following information is recorded for debugging --- self.blocked_graphs","the input args of a block. assert len(block.inputargs) == len(inputcells) for a, cell","is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished #","\"\"\"Return the known type of a control flow graph variable, defaulting to 'object'.\"\"\"","renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs = renaming.get(v, []) for","for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) ==","newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks:","# XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy)","self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not None:","def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase,","hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells,","= newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items():","high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about","block, i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops","from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = (","s_variable.knowntype else: return object else: raise TypeError(\"Variable or Constant instance expected, \" \"got","a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg","callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback] = True #","self.frozen = False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy =","= self.annotated # all of them for block in newblocks: for op in","s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant():","s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject)","if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {}","if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known type of","else: # dead code removal: don't follow all exits if the exitswitch #","self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = []","of debugging information --- self.frozen = False if policy is None: from rpython.annotator.policy","self.added_blocks if newblocks is None: newblocks = self.annotated # all of them for","enter an op; the latter can result in violations of the # more","= constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try to pass","subclass e.source = gather_error(self, graph, block, i) raise else: # dead code removal:","new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as","valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue corresponding to the given Variable","KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value):","to always raise an exception. We then # swallow the BlockedInference and that's","pos = '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" %","annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue corresponding to","newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check","def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated #","the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming):","= typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'):","up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError","v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif","is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant():","% annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None): if","#___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic","isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object else:","if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\"Variable or Constant instance","s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link,","self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks until none is left.\"\"\" while True:","it should try to progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator =","class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description in doc/translation.txt.\"\"\" def __init__(self, translator=None,","text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v","finished # make sure that the return variables of all graphs is annotated","# wrong number of args # register the entry point self.addpendinggraph(flowgraph, inputcells) #","else: return object else: raise TypeError(\"Variable or Constant instance expected, \" \"got %r\"","annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper","operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind","= (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells'","return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if","failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack","the annotations based on operations ______ def consider_op(self, op): # let's be careful","self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not","block. # * self.annotated[block] == graph-containing-block: # analysis done (at least until we","debugging --- self.blocked_graphs = {} # set of graphs that have blocked blocks","renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const","analysis done (at least until we find we must generalize the # input","not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks","def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is","if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if","_______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset","in blocks _____________________ def processblock(self, graph, block): # Important: this is not called","= AnnotatorPolicy() # make input arguments and set their type args_s = [self.typeannotation(t)","and don't annotate the old # graph -- it's already low-level operations! for","graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations","if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX","done (at least until we find we must generalize the # input variables).","if translator is None: # interface for tests from rpython.translator.translator import TranslationContext translator","results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool #","from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set","perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph, block): # Important:","Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else:","for v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs:","# this is the case where the last operation of the block will","from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from","= False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as","get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy","= (graph, e.opindex) except Exception as e: # hack for debug tools only","= policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self,","position_key): graph, block, i = position_key blk = \"\" if block: at =","inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph,","is not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs)","op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some blocks","link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link","s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out =","exceptions that `operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None:","Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming =","defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args,","'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for","None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the type","block in newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield","self.policy = policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications for","and set their type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX","assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block not in","self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks","self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def","Variable or Constant.\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError return","= op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e:","in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs =","e: if e.op is block.raising_op: # this is the case where the last","low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg,","already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert","+= renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const =","in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out","at = block.at() if at: blk = \" block\"+at opid=\"\" if i is","are passed in, and don't annotate the old # graph -- it's already","import model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection,","self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert","assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block","Constant.\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError return s_arg def","if self.added_blocks is not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs","wrong number of args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively","rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul)","parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) #","s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else:","renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self,","set of {blocked_block: (graph, index)} # --- the following information is recorded for","AttributeError: self.break_at = None self.op = op self.opindex = opindex def __repr__(self): if","with the flow object space. These are the operations for # which it","make sure that the return variables of all graphs is annotated if self.added_blocks","in newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op","UnionError is a subclass e.source = gather_error(self, graph, block, i) raise else: #","SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the type inference engine","rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set their","enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False)","simplify, transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model import (","the situation is currently blocked, and that it should try to progress elsewhere.\"\"\"","renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out =","raise # if the merged cells changed, we must redo the analysis if","import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant,","in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s","block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def","isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph,","the initial bindings for the input args of a block. assert len(block.inputargs) ==","callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase,","self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph,","= graph assert block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block]","is the case where the last operation of the block will # always","block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {} for link in exits: constraints =","statement so far. # (some functions actually never do, they always raise exceptions)","an exception which is immediately caught by # an exception handler. We then","operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This","def gettype(self, variable): \"\"\"Return the known type of a control flow graph variable,","graph that has already been rtyped. Safety-check the new # annotations that are","called recursively. # self.flowin() can only issue calls to self.addpendingblock(). # The analysis","# Merge the new 'cells' with each of the block's existing input #","are partially annotated if op.result.annotation is None: break # ignore the unannotated part","problematic (but will hopefully be solved # later by reflowing). Throw the BlockedInference","v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't reach","the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value","intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case)","{}) if whence is not None: if callable(whence): def callback(): whence(self, graph) else:","[annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source","i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self)","warning, keep the name of the call operations in sync # with the","if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if","None self.op = op self.opindex = opindex def __repr__(self): if not self.break_at: break_at","if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for","parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call #","inputcells): # Create the initial bindings for the input args of a block.","= False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True","self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation): \"\"\" Return the","BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result,","this is the case where the last operation of the block will #","* self.annotated[block] == False: # the input variables of the block have bindings","newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph,","graph, block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph","raise TypeError(\"Variable or Constant instance expected, \" \"got %r\" % (variable,)) def getuserclassdefinitions(self):","is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ...","until no more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def","True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in self.fixed_graphs","if case is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break","cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block)","(should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self,","self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks =","is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep","self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___","= True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get","# * self.annotated[block] == False: # the input variables of the block have","SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception","checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args","tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict","# variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2)","for all exceptions that `operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw","graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def","self self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated =","information --- self.frozen = False if policy is None: from rpython.annotator.policy import AnnotatorPolicy","transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs =","an additional # small helper creates. if self.added_blocks is not None: self.added_blocks[block] =","inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register an entry point into block with","{} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to","if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert","= len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args # register","if pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?'","isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input","for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph,","graph, block, inputcells): # Create the initial bindings for the input args of","set of blocks already seen self.added_blocks = None # see processblock() below self.links_followed","op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if","which are the new blocks that annotating an additional # small helper creates.","not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the","links that try to pass impossible values if s_out == s_ImpossibleValue: ignore_link =","cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block]","arg): \"Gives the SomeValue corresponding to the given Variable or Constant.\" if isinstance(arg,","elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if","is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph, block):","gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform","source code to the UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise #","self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block)","# all of them for block in newblocks: for op in block.operations: if","# reflow from certain positions when this block is done for callback in","the latter can result in violations of the # more general results invariant:","= v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out","None: break # ignore the unannotated part #___ simplification (should be moved elsewhere?)","in exits: case = link.exitcase if case is None: self.follow_link(graph, link, {}) continue","= False inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args,","for link in block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call',","from certain positions when this block is done for callback in self.notify[block]: if","{block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to annotate again","self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None: from","an entry point into block with the given input cells.\"\"\" if graph in","# get the (current) return value v = graph.getreturnvar() try: return self.binding(v) except","block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell)","annotating an additional # small helper creates. if self.added_blocks is not None: self.added_blocks[block]","link.target, inputs_s) #___ creating the annotations based on operations ______ def consider_op(self, op):","effects if translator is None: # interface for tests from rpython.translator.translator import TranslationContext","inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy","s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase,","inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True","is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy","('simple_call', 'call_args', 'next'): # XXX warning, keep the name of the call operations","of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is","has already been rtyped. Safety-check the new # annotations that are passed in,","__getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret","v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and","assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph,","for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items():","(types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value,","finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is","complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending","s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\",","{} # set of links that have ever been followed self.notify = {}","= False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy()","graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] =","self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy","opid=\"\" if i is not None: opid = \" op=%d\" % i return","assert False arg.annotation = s_value def warning(self, msg, pos=None): if pos is None:","in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if","must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): # Create","= new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if e.op is","all of them for block in newblocks: for op in block.operations: if op.opname","Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {} for link","None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case))","that the situation is currently blocked, and that it should try to progress","raise an exception. We then # swallow the BlockedInference and that's it. #","rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See","case for annotating/rtyping in several phases: calling # a graph that has already","type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value)","None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks","that `operation` may raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return","that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue","raise an exception which is immediately caught by # an exception handler. We","= False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block,","s_value): s_old = arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\"%s","s_arg = self.annotation(arg) if s_arg is None: raise KeyError return s_arg def typeannotation(self,","rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import","block not in self.annotated: # never seen the block. # * self.annotated[block] ==","s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key):","blocks until none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break","for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done","KeyError: # the function didn't reach any return statement so far. # (some","{} self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy,","is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen","annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self,","None, long=True)) raise # if the merged cells changed, we must redo the","graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag =","return block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if","annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False)","True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___","point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy()","is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in the assert of","knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link,","the UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged","processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try:","break # finished # make sure that the return variables of all graphs","policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack","from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error,","self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure that the return","# has side effects if translator is None: # interface for tests from","done in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text =","args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self,","this is not called recursively. # self.flowin() can only issue calls to self.addpendingblock().","= self.annotation(arg) if s_arg is None: raise KeyError return s_arg def typeannotation(self, t):","block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks until none","def addpendingblock(self, graph, block, cells): \"\"\"Register an entry point into block with the","the # input variables). #print '* processblock', block, cells self.annotated[block] = graph if","def warning(self, msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key except","s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue:","a block can be in three states: # * block not in self.annotated:","self.annotated[block] == False: # the input variables of the block have bindings but","--- the following information is recorded for debugging --- self.blocked_graphs = {} #","= s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation","index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is","i = position_key blk = \"\" if block: at = block.at() if at:","the unannotated part #___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None,","some blocks are partially annotated if op.result.annotation is None: break # ignore the","yield op # some blocks are partially annotated if op.result.annotation is None: break","but we # still have to consider all the operations in the block.","constraints) if block in self.notify: # reflow from certain positions when this block","def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block]","s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc","self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value =","self.translator.graphs else: graphs = {} for block in block_subset: graph = self.annotated.get(block) if","the exceptional # branches. exits = [link for link in block.exits if link.exitcase","arg): \"Gives the SomeValue corresponding to the given Variable or Constant.\" s_arg =","typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata","self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in self.annotated.items() if done","type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if","block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in exits: case =","a position else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType,","s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating","None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks =","False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e:","creates. if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block):","follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType,","# map {block: graph-containing-it} self.annotated = {} # set of blocks already seen","operation): \"\"\" Return the annotation for all exceptions that `operation` may raise. \"\"\"","# to enter an op; the latter can result in violations of the","follow all exits if the exitswitch # is known exits = block.exits if","False: # the input variables of the block have bindings but we #","in self.fixed_graphs: # special case for annotating/rtyping in several phases: calling # a","v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] =","graphs is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for block","positions when this block is done for callback in self.notify[block]: if isinstance(callback, tuple):","== s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc !=","block: at = block.at() if at: blk = \" block\"+at opid=\"\" if i","def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence","= translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {} #","constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs =","values if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out)","self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations","= v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link]","self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def callback(): whence(self, graph)","= ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy)","input args of a block. assert len(block.inputargs) == len(inputcells) for a, cell in","and that it should try to progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex):","s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata","for RPython. See description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry","= op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue:","new_ops if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i","not None: if not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" % (s_value, s_old))","e: # hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block',","False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks","that's it. # About 'next': see test_annotate_iter_empty_container(). return else: # other cases are","True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph,","to progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at","import simplify, transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model import","import rpython.rtyper.extfuncregistry # has side effects if translator is None: # interface for","annotated if op.result.annotation is None: break # ignore the unannotated part #___ simplification","if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] =","of args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until","\" block\"+at opid=\"\" if i is not None: opid = \" op=%d\" %","should try to progress elsewhere.\"\"\" def __init__(self, annotator, op, opindex): self.annotator = annotator","return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the type inference engine that the","the block. # * self.annotated[block] == graph-containing-block: # analysis done (at least until","# {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to annotate","in, and don't annotate the old # graph -- it's already low-level operations!","zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const","return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells)","block\"+at opid=\"\" if i is not None: opid = \" op=%d\" % i","the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) #","graphs = self.translator.graphs else: graphs = {} for block in block_subset: graph =","new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1 except","# bind resultcell to op.result def get_exception(self, operation): \"\"\" Return the annotation for","= annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op =","only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks'","latter can result in violations of the # more general results invariant: e.g.","self.annotated # all of them for block in newblocks: for op in block.operations:","and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list) for","is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for block in","if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise","import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import","AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells","def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________","= {} # set of links that have ever been followed self.notify =","proceed until no more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar())","cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen","-- in the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue):","assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out =","= self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy):","got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks","let's be careful about avoiding propagated SomeImpossibleValues # to enter an op; the","# dead code removal: don't follow all exits if the exitswitch # is","for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position","(pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if","from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython.","new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const","{} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in","s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for","# set of graphs not to annotate again self.blocked_blocks = {} # set","information is recorded for debugging --- self.blocked_graphs = {} # set of graphs","if the exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch","self.notify: # reflow from certain positions when this block is done for callback","is a subclass e.source = gather_error(self, graph, block, i) raise else: # dead","policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function,","<filename>rpython/annotator/annrpython.py from __future__ import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print","zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not","self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return","None: graphs = self.translator.graphs else: graphs = {} for block in block_subset: graph","moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes)","# later by reflowing). Throw the BlockedInference up to # processblock(). e.opindex =","# Important: this is not called recursively. # self.flowin() can only issue calls","% (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level","= annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out","is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is","is not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result","for block, done in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks)","return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the type inference","in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if","annotations in blocks _____________________ def processblock(self, graph, block): # Important: this is not","self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def","except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError is a","#all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in","for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs):","self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {}","the flow object space. These are the operations for # which it is","= self.translator.graphs else: graphs = {} for block in block_subset: graph = self.annotated.get(block)","translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is None:","for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator","self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells)","self.notify[graph.returnblock] is a dictionary of call # points to this func which triggers","as e: # Add source code to the UnionError e.source = '\\n'.join(source_lines(graph, block,","= position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is None:","be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset,","opid def flowin(self, graph, block): try: i = 0 while i < len(block.operations):","v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out =","v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming)","raise. \"\"\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return","of the # more general results invariant: e.g. if SomeImpossibleValue enters is_ #","if key not in attrs: assert type(value) is dict, ( \"%r is not","if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self,","knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow from certain","= {} return ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types,","s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase == s_exitswitch.const] if","from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator","new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if not","blocks # --- end of debugging information --- self.frozen = False if policy","# callback is a position else: callback() def follow_link(self, graph, link, constraints): assert","be careful about avoiding propagated SomeImpossibleValues # to enter an op; the latter","import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set their type","XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph,","interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block,","in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self):","if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph,","def processblock(self, graph, block): # Important: this is not called recursively. # self.flowin()","callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else:","self.binding(v) except KeyError: # the function didn't reach any return statement so far.","[self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in","defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out","as e: # note that UnionError is a subclass e.source = gather_error(self, graph,","renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based","ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value):","in several phases: calling # a graph that has already been rtyped. Safety-check","Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed notify","exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block)","# an exception handler. We then only follow the exceptional # branches. exits","= flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc =","cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self):","position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks","not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1","inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number","s_newarg) == s_oldarg else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph,","# --- end of debugging information --- self.frozen = False if policy is","\"%r is not dict. please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {}","didn't reach any return statement so far. # (some functions actually never do,","except BlockedInference as e: if e.op is block.raising_op: # this is the case","# which it is fine to always raise an exception. We then #","that UnionError is a subclass e.source = gather_error(self, graph, block, i) raise else:","block is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback","s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link]","annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph","medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph,","value v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't","annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block not in self.annotated:","in self.annotated: # never seen the block. # * self.annotated[block] == False: #","{} return ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True,","self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph","redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out,","None: # interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator","s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out)","None # see processblock() below self.links_followed = {} # set of links that","self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {} # set of","def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks =","the SomeValue corresponding to the given Variable or Constant.\" s_arg = self.annotation(arg) if","= dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all of","inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register an entry point","return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is","op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is","that are passed in, and don't annotate the old # graph -- it's","= self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks until none is left.\"\"\"","s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {}","rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator","issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type,","== v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant():","that annotating an additional # small helper creates. if self.added_blocks is not None:","else: graphs = {} for block in block_subset: graph = self.annotated.get(block) if graph:","BlockedInference as e: if e.op is block.raising_op: # this is the case where","(format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify,","attrs: assert type(value) is dict, ( \"%r is not dict. please update %s.__getstate__\"","self.flowin() can only issue calls to self.addpendingblock(). # The analysis of a block","i is not None: opid = \" op=%d\" % i return repr(graph) +","operations for # which it is fine to always raise an exception. We","assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op,","inputs_s) #___ creating the annotations based on operations ______ def consider_op(self, op): #","= self.added_blocks if newblocks is None: newblocks = self.annotated # all of them","input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v =","\"\"\"Recursively build annotations about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\"","opid = \" op=%d\" % i return repr(graph) + blk + opid def","if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if","we must redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def","None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph","situation is currently blocked, and that it should try to progress elsewhere.\"\"\" def","generalize the # input variables). #print '* processblock', block, cells self.annotated[block] = graph","to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation","about avoiding propagated SomeImpossibleValues # to enter an op; the latter can result","= saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells)","policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self):","TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self, arg): \"Gives the","= self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block","for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else:","self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack for debug tools","== s_oldarg else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block,","code to the UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise # if","side effects if translator is None: # interface for tests from rpython.translator.translator import","%r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___","if s_arg is None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t,","# hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block)","saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) ==","in self.notify: # reflow from certain positions when this block is done for","= self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() # invoke","_______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index =","= new_ops if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op)","# must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): #","args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try:","# must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): #","self.annotated[block] == graph-containing-block: # analysis done (at least until we find we must","ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] =","v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if","Constant expected, got %r' % (arg,)) def binding(self, arg): \"Gives the SomeValue corresponding","repr(graph) + blk + opid def flowin(self, graph, block): try: i = 0","= self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now)","if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out,","__init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is","don't follow all exits if the exitswitch # is known exits = block.exits","not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value,","None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self,","instance expected, \" \"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of","in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to the UnionError","or Constant instance expected, \" \"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a","= graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the","are problematic (but will hopefully be solved # later by reflowing). Throw the","(variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface","by # an exception handler. We then only follow the exceptional # branches.","(current) return value v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the","until none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break #","'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if","based on operations ______ def consider_op(self, op): # let's be careful about avoiding","{}) else: knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase, {})","done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit()","block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence","see processblock() below self.links_followed = {} # set of links that have ever","= self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for","= 0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)):","not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result op","def get_exception(self, operation): \"\"\" Return the annotation for all exceptions that `operation` may","= True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations ______","s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints","# self.flowin() can only issue calls to self.addpendingblock(). # The analysis of a","e.opindex) except Exception as e: # hack for debug tools only if not","'* processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block]","call # points to this func which triggers a reflow whenever the #","\"\" if block: at = block.at() if at: blk = \" block\"+at opid=\"\"","block) def complete(self): \"\"\"Process pending blocks until none is left.\"\"\" while True: self.complete_pending_blocks()","# is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if","block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs","if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if","= renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool)","typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations","callback is a position else: callback() def follow_link(self, graph, link, constraints): assert not","#___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build","in exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception =","can be in three states: # * block not in self.annotated: # never","\"\"\" Return the annotation for all exceptions that `operation` may raise. \"\"\" can_only_throw","if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable:","# set of links that have ever been followed self.notify = {} #","Merge the new 'cells' with each of the block's existing input # variables.","= intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception,","this block is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) #","None: opid = \" op=%d\" % i return repr(graph) + blk + opid","== nbarg # wrong number of args # register the entry point self.addpendinggraph(flowgraph,","= {} # set of graphs not to annotate again self.blocked_blocks = {}","i) raise else: # dead code removal: don't follow all exits if the","= block.raising_op s_exception = self.get_exception(op) for link in exits: case = link.exitcase if","= pair(s_out, s_constraint).improve() # ignore links that try to pass impossible values if","is immediately caught by # an exception handler. We then only follow the","except BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] =","log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None):","[] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell","blk = \" block\"+at opid=\"\" if i is not None: opid = \"","new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True):","block): # Important: this is not called recursively. # self.flowin() can only issue","self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs","self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs","pair(s_out, s_constraint).improve() # ignore links that try to pass impossible values if s_out","= link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value","s_exception = self.get_exception(op) for link in exits: case = link.exitcase if case is","False arg.annotation = s_value def warning(self, msg, pos=None): if pos is None: try:","= link.exitcase if case is None: self.follow_link(graph, link, {}) continue if s_exception ==","!= s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable):","SomeImpossibleValues # to enter an op; the latter can result in violations of","get_exception(self, operation): \"\"\" Return the annotation for all exceptions that `operation` may raise.","self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface __________________ def build_types(self,","self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known type of a control","not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem()","= s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block,","'added_blocks' is used by rpython.annlowlevel to # detect which are the new blocks","addpendingblock(self, graph, block, cells): \"\"\"Register an entry point into block with the given","except AttributeError: self.break_at = None self.op = op self.opindex = opindex def __repr__(self):","warning(self, msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key except AttributeError:","i = 0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block,","v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out","dict 'added_blocks' is used by rpython.annlowlevel to # detect which are the new","tag) # self.notify[graph.returnblock] is a dictionary of call # points to this func","Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import model as","--- end of debugging information --- self.frozen = False if policy is None:","= variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\"Variable or","isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in","s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception =","position_key blk = \"\" if block: at = block.at() if at: blk =","parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is","block can be in three states: # * block not in self.annotated: #","AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s,","self.blocked_blocks = {} # set of {blocked_block: (graph, index)} # --- the following","import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from","bindings for the input args of a block. assert len(block.inputargs) == len(inputcells) for","prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy import","the given Variable or Constant.\" s_arg = self.annotation(arg) if s_arg is None: raise","not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block,","[self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph,","= op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops:","all exits if the exitswitch # is known exits = block.exits if isinstance(block.exitswitch,","(s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self,","function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None)","exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: #","self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s,","elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r'","can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals","have to consider all the operations in the block. # * self.annotated[block] ==","self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def","s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\"Variable","False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells):","self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph","'cells' with each of the block's existing input # variables. oldcells = [self.binding(a)","in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name of the call","def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy =","complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy =","arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self)","\" \"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return","self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type =","bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is None: # interface","(some functions actually never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self,","phases: calling # a graph that has already been rtyped. Safety-check the new","self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self,","v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s =","if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link,","block, inputcells): # Create the initial bindings for the input args of a","None) -> SomeBool(const=False) ... # boom -- in the assert of setbinding() for","partially annotated if op.result.annotation is None: break # ignore the unannotated part #___","try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex","for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block,","# set of graphs that have blocked blocks # --- end of debugging","raise BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert","to pass impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out =","flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register an entry point into block","'__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used by rpython.annlowlevel","( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph","# more general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None)","tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator =","inputcells) # recursively proceed until no more pending block is left if complete_now:","intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\")","number of args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed","if not s_value.contains(s_old): log.WARNING(\"%s does not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" %","temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack for debug","while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \"\"\"Process pending blocks","= self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint()","ret.items(): if key not in attrs: assert type(value) is dict, ( \"%r is","isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make","getuserclassdefinitions(self): \"\"\"Return a list of ClassDefs.\"\"\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def","block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block,","= s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value,","s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out","= True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in","and that's it. # About 'next': see test_annotate_iter_empty_container(). return else: # other cases","always raise an exception which is immediately caught by # an exception handler.","pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return","from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper","(arg,)) def binding(self, arg): \"Gives the SomeValue corresponding to the given Variable or","is a dictionary of call # points to this func which triggers a","annotate the old # graph -- it's already low-level operations! for a, s_newarg","isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out","assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result","block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs:","= \"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy()","transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model import ( typeof,","if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out,","= {} # set of {blocked_block: (graph, index)} # --- the following information","i return repr(graph) + blk + opid def flowin(self, graph, block): try: i","if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception","= self.__dict__.copy() for key, value in ret.items(): if key not in attrs: assert","isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self, graph,","in violations of the # more general results invariant: e.g. if SomeImpossibleValue enters","if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata =","self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] =","constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow","signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not","except KeyError: # the function didn't reach any return statement so far. #","None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if","is recorded for debugging --- self.blocked_graphs = {} # set of graphs that","link in block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args',","return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else:","format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar()","[block for block, done in self.annotated.items() if done is False] assert len(blocked_blocks) ==","return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known type of a control flow","def complete(self): \"\"\"Process pending blocks until none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self)","variables of all graphs is annotated if self.added_blocks is not None: newgraphs =","for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value])","not self.break_at: break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s","def callback(): whence(self, graph) else: callback = whence callpositions[callback] = True # generalize","(graph, e.opindex) except Exception as e: # hack for debug tools only if","in attrs: assert type(value) is dict, ( \"%r is not dict. please update","resultcell to op.result def get_exception(self, operation): \"\"\" Return the annotation for all exceptions","self.get_exception(op) for link in exits: case = link.exitcase if case is None: self.follow_link(graph,","op self.opindex = opindex def __repr__(self): if not self.break_at: break_at = \"?\" else:","to enter an op; the latter can result in violations of the #","defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable =","block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not","__future__ import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger","exception which is immediately caught by # an exception handler. We then only","does not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False","left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known type","'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype","graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks","the BlockedInference up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return","--- self.frozen = False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy","Add source code to the UnionError e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise","has side effects if translator is None: # interface for tests from rpython.translator.translator","annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None: resultcell","graph.startblock, inputcells) # get the (current) return value v = graph.getreturnvar() try: return","t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s =","True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value","\"\"\"This exception signals the type inference engine that the situation is currently blocked,","that have blocked blocks # --- end of debugging information --- self.frozen =","if block: at = block.at() if at: blk = \" block\"+at opid=\"\" if","inference engine that the situation is currently blocked, and that it should try","actually never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph,","graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if","BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph,","{block: graph-containing-it} self.annotated = {} # set of blocks already seen self.added_blocks =","# note that UnionError is a subclass e.source = gather_error(self, graph, block, i)","= opindex def __repr__(self): if not self.break_at: break_at = \"?\" else: break_at =","all the operations in the block. # * self.annotated[block] == graph-containing-block: # analysis","(graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with","= (graph, None) def bindinputargs(self, graph, block, inputcells): # Create the initial bindings","import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from","True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations ______ def","their type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul","if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v]","flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong","from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper","self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() #","# other cases are problematic (but will hopefully be solved # later by","self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks)","the new blocks that annotating an additional # small helper creates. if self.added_blocks","v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that","self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg","graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as","in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out","in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback()","that try to pass impossible values if s_out == s_ImpossibleValue: ignore_link = True","if not self.pendingblocks: break # finished # make sure that the return variables","v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links","%r' % (arg,)) def binding(self, arg): \"Gives the SomeValue corresponding to the given","msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos","issue calls to self.addpendingblock(). # The analysis of a block can be in","% i return repr(graph) + blk + opid def flowin(self, graph, block): try:","type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul =","not called recursively. # self.flowin() can only issue calls to self.addpendingblock(). # The","that have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs =","assert len(inputcells) == nbarg # wrong number of args # register the entry","link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning,","inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input)","is not called recursively. # self.flowin() can only issue calls to self.addpendingblock(). #","not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in","self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def","return s_variable.knowntype else: return object else: raise TypeError(\"Variable or Constant instance expected, \"","hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used by","= \"\" if block: at = block.at() if at: blk = \" block\"+at","if block in self.notify: # reflow from certain positions when this block is","bindings but we # still have to consider all the operations in the","generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return","in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in","______ def consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues #","self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def","contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation =","of graphs not to annotate again self.blocked_blocks = {} # set of {blocked_block:","# About 'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic (but","annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index","annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def","in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function,","AnnotatorPolicy() # make input arguments and set their type args_s = [self.typeannotation(t) for","can only issue calls to self.addpendingblock(). # The analysis of a block can","annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError is a subclass","== s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return","% (arg,)) def binding(self, arg): \"Gives the SomeValue corresponding to the given Variable","self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the new","constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try","graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self):","got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] =","all graphs is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for","not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used","not self.pendingblocks: break # finished # make sure that the return variables of","= [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2","for v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint =","self.consider_op(op) i += 1 except BlockedInference as e: if e.op is block.raising_op: #","for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s","gettype(self, variable): \"\"\"Return the known type of a control flow graph variable, defaulting","any return statement so far. # (some functions actually never do, they always","self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False # failed,","function, input_arg_types, complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the specific entry point.\"\"\" assert","blk + opid def flowin(self, graph, block): try: i = 0 while i","# is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in the assert","Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import model as annmodel,","newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated # all of","not None: opid = \" op=%d\" % i return repr(graph) + blk +","extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs = {} for","s in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] =","if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i +=","ret = self.__dict__.copy() for key, value in ret.items(): if key not in attrs:","if newblocks is None: newblocks = self.annotated # all of them for block","Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise","RPython. See description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry #","policy = AnnotatorPolicy() # make input arguments and set their type args_s =","zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type:","import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description","#___ flowing annotations in blocks _____________________ def processblock(self, graph, block): # Important: this","except annmodel.AnnotatorError as e: # note that UnionError is a subclass e.source =","# a graph that has already been rtyped. Safety-check the new # annotations","in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in self.annotated.items()","self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in self.annotated.items() if","to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as","import Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import model","each of the block's existing input # variables. oldcells = [self.binding(a) for a","are the new blocks that annotating an additional # small helper creates. if","of them for block in newblocks: for op in block.operations: if op.opname in","follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link","Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out =","None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul =","import TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks =","function, args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy =","assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type,","never seen the block. # * self.annotated[block] == False: # the input variables","for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing","policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy,","of a control flow graph variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return","raise # The dict 'added_blocks' is used by rpython.annlowlevel to # detect which","is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1)","is not dict. please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {} return","graph, block): try: i = 0 while i < len(block.operations): op = block.operations[i]","= parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call","= self self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated","processblock(self, graph, block): # Important: this is not called recursively. # self.flowin() can","rtyped. Safety-check the new # annotations that are passed in, and don't annotate","____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells):","careful about avoiding propagated SomeImpossibleValues # to enter an op; the latter can","old # graph -- it's already low-level operations! for a, s_newarg in zip(block.inputargs,","if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = []","ignore the unannotated part #___ simplification (should be moved elsewhere?) _______ def simplify(self,","link.exitcase if case is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue:","index)} # --- the following information is recorded for debugging --- self.blocked_graphs =","unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: #","avoiding propagated SomeImpossibleValues # to enter an op; the latter can result in","policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value in ret.items(): if key not","end of debugging information --- self.frozen = False if policy is None: from","binding(self, arg): \"Gives the SomeValue corresponding to the given Variable or Constant.\" s_arg","= AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self)","\"\"\"Block annotator for RPython. See description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None):","assert type(value) is dict, ( \"%r is not dict. please update %s.__getstate__\" %","of the block have bindings but we # still have to consider all","operations in the block. # * self.annotated[block] == graph-containing-block: # analysis done (at","as e: # hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e,","cells changed, we must redo the analysis if unions != oldcells: self.bindinputargs(graph, block,","link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr(","input variables). #print '* processblock', block, cells self.annotated[block] = graph if block in","assert block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph,","v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException))","s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i = position_key blk =","graph -- it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg","again self.blocked_blocks = {} # set of {blocked_block: (graph, index)} # --- the","if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset","# * block not in self.annotated: # never seen the block. # *","block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some blocks are partially","block's existing input # variables. oldcells = [self.binding(a) for a in block.inputargs] try:","self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph,","import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import","annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy","blocked_blocks = [block for block, done in self.annotated.items() if done is False] assert","is currently blocked, and that it should try to progress elsewhere.\"\"\" def __init__(self,","Important: this is not called recursively. # self.flowin() can only issue calls to","if s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase == s_exitswitch.const]","def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with each of","# analysis done (at least until we find we must generalize the #","if callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback] = True","invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not","is fine to always raise an exception. We then # swallow the BlockedInference","# failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: #","be solved # later by reflowing). Throw the BlockedInference up to # processblock().","self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op","graph, block, cells): \"\"\"Register an entry point into block with the given input","the # return block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock,","s_variable: return s_variable.knowntype else: return object else: raise TypeError(\"Variable or Constant instance expected,","msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence,","self.addpendingblock(). # The analysis of a block can be in three states: #","# let's be careful about avoiding propagated SomeImpossibleValues # to enter an op;","# finished # make sure that the return variables of all graphs is","it is fine to always raise an exception. We then # swallow the","def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg","is used by rpython.annlowlevel to # detect which are the new blocks that","attrs = \"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split() ret =","isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {} for","this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not","= self.get_exception(op) for link in exits: case = link.exitcase if case is None:","self.annotated: # never seen the block. # * self.annotated[block] == False: # the","* block not in self.annotated: # never seen the block. # * self.annotated[block]","given Variable or Constant.\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError","self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc","whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary","they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index =","set their type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack","typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs):","position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks","'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic (but will hopefully","for annotating/rtyping in several phases: calling # a graph that has already been","self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \"\"\"Return the known type of a control flow graph","complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy","block_subset is None: graphs = self.translator.graphs else: graphs = {} for block in","\"\"\"Process pending blocks until none is left.\"\"\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not","complete_now=True, main_entry_point=False): \"\"\"Recursively build annotations about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType),","not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = []","#raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation","block in self.notify: # reflow from certain positions when this block is done","for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)]","graph-containing-block: # analysis done (at least until we find we must generalize the","newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values()","not dict. please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {} return ret","#___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self,","of graphs that have blocked blocks # --- end of debugging information ---","processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: #","if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX","len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph","= [link for link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op","pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface for annotator.bookkeeper _______","on operations ______ def consider_op(self, op): # let's be careful about avoiding propagated","inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on","operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg)","def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register","[link for link in block.exits if link.exitcase is not None] elif e.op.opname in","pos=None): if pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos =","= [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in","graph) else: callback = whence callpositions[callback] = True # generalize the function's input","inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy","def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\"\"\".split()","s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self,","is not None: opid = \" op=%d\" % i return repr(graph) + blk","followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of","got %r' % (arg,)) def binding(self, arg): \"Gives the SomeValue corresponding to the","note that UnionError is a subclass e.source = gather_error(self, graph, block, i) raise","# the input variables of the block have bindings but we # still","# some blocks are partially annotated if op.result.annotation is None: break # ignore","link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value","seen self.added_blocks = None # see processblock() below self.links_followed = {} # set","a graph that has already been rtyped. Safety-check the new # annotations that","annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata)","assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() #","creating the annotations based on operations ______ def consider_op(self, op): # let's be","s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try to","them for block in newblocks: for op in block.operations: if op.opname in ('simple_call',","the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy","-1) resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell","= {} # set of blocks already seen self.added_blocks = None # see","pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph","None) def bindinputargs(self, graph, block, inputcells): # Create the initial bindings for the","types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair","tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag)","blocked blocks # --- end of debugging information --- self.frozen = False if","block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not None:","addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \"\"\"Register an","s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log","policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy =","used by rpython.annlowlevel to # detect which are the new blocks that annotating","bookkeeper frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value in ret.items(): if","= block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not","TypeError(\"Variable or Constant instance expected, \" \"got %r\" % (variable,)) def getuserclassdefinitions(self): \"\"\"Return","apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of:","pass impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out,","type of a control flow graph variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant):","which is immediately caught by # an exception handler. We then only follow","[] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out,","if the merged cells changed, we must redo the analysis if unions !=","defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error,","Return the annotation for all exceptions that `operation` may raise. \"\"\" can_only_throw =","been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set","input arguments and set their type args_s = [self.typeannotation(t) for t in input_arg_types]","-> SomeBool(const=False) ... # boom -- in the assert of setbinding() for arg","initial bindings for the input args of a block. assert len(block.inputargs) == len(inputcells)","graph, block): # Important: this is not called recursively. # self.flowin() can only","assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s =","handler. We then only follow the exceptional # branches. exits = [link for","policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return","!= '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface for","functions actually never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key):","in the block. # * self.annotated[block] == graph-containing-block: # analysis done (at least","annotations that are passed in, and don't annotate the old # graph --","exception handler. We then only follow the exceptional # branches. exits = [link","results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue corresponding to the","assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block]","reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] =","self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase ==","# see processblock() below self.links_followed = {} # set of links that have","the block. # * self.annotated[block] == False: # the input variables of the","callback(): whence(self, graph) else: callback = whence callpositions[callback] = True # generalize the","def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in","# ignore links that try to pass impossible values if s_out == s_ImpossibleValue:","rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block","break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s [%s]>\" %(break_at, self.op) __str__ = __repr__","annmodel.UnionError as e: # Add source code to the UnionError e.source = '\\n'.join(source_lines(graph,","space. These are the operations for # which it is fine to always","s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else:","doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if","graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't reach any return","except annmodel.UnionError as e: # Add source code to the UnionError e.source =","description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side","+ blk + opid def flowin(self, graph, block): try: i = 0 while","collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error","must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge","new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out,","dict. please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___","don't annotate the old # graph -- it's already low-level operations! for a,","return s_out def whereami(self, position_key): graph, block, i = position_key blk = \"\"","for key, value in ret.items(): if key not in attrs: assert type(value) is","hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point:","s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target,","as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex)","del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False #","# The dict 'added_blocks' is used by rpython.annlowlevel to # detect which are","bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs =","These are the operations for # which it is fine to always raise","object space. These are the operations for # which it is fine to","reflow whenever the # return block of this graph has been analysed. callpositions","block) def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated","renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const =","block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as","reflow from certain positions when this block is done for callback in self.notify[block]:","callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) #","= self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?': pos =","elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed","AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper","None), None) -> SomeBool(const=False) ... # boom -- in the assert of setbinding()","break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s [%s]>\" %(break_at,","is None: # interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext()","please update %s.__getstate__\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience","def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks","block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph,","are the operations for # which it is fine to always raise an","existing input # variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions","a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except","swallow the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return else:","by rpython.annlowlevel to # detect which are the new blocks that annotating an","e.source = gather_error(self, graph, block, i) raise else: # dead code removal: don't","case is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case","validate(self): \"\"\"Check that the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives","isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None:","rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks","entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy =","s_old = arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\"%s does","several phases: calling # a graph that has already been rtyped. Safety-check the","callback = whence callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph,","pos != '?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface","of a block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells):","types.FunctionType), \"fix that!\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input","if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable","of the call operations in sync # with the flow object space. These","unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'):","else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if","hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert","See description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has","block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0]","hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack for","following information is recorded for debugging --- self.blocked_graphs = {} # set of","perform_normalizations log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description in","= [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add","self.pendingblocks: break # finished # make sure that the return variables of all","make input arguments and set their type args_s = [self.typeannotation(t) for t in","XXX warning, keep the name of the call operations in sync # with","set of links that have ever been followed self.notify = {} # {block:","setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used by rpython.annlowlevel to","= prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy","AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set their type args_s","= Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \"\"\"translator pendingblocks annotated links_followed","as e: if e.op is block.raising_op: # this is the case where the","setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not None: if not","in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify:","variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\"Variable or Constant","of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1)","opindex def __repr__(self): if not self.break_at: break_at = \"?\" else: break_at = self.annotator.whereami(self.break_at)","as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from","graph variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable):","graph, block, inputcells): # Merge the new 'cells' with each of the block's","return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy","exits: case = link.exitcase if case is None: self.follow_link(graph, link, {}) continue if","states: # * block not in self.annotated: # never seen the block. #","expected, got %r' % (arg,)) def binding(self, arg): \"Gives the SomeValue corresponding to","try: return self.binding(v) except KeyError: # the function didn't reach any return statement","len(inputcells) == nbarg # wrong number of args # register the entry point","= arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\"%s does not","try: i = 0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph,","translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {} # set","helper creates. if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph,","for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell =","the exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch =","hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise","len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs:","# make sure that the return variables of all graphs is annotated if","in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] =","= TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {} # map","resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op,","recursively. # self.flowin() can only issue calls to self.addpendingblock(). # The analysis of","object else: raise TypeError(\"Variable or Constant instance expected, \" \"got %r\" % (variable,))","recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag","annotator for RPython. See description in doc/translation.txt.\"\"\" def __init__(self, translator=None, policy=None, bookkeeper=None): import","= op self.opindex = opindex def __repr__(self): if not self.break_at: break_at = \"?\"","constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert","s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target,","else: callback = whence callpositions[callback] = True # generalize the function's input arguments","if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph =","s_out def whereami(self, position_key): graph, block, i = position_key blk = \"\" if","Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input in","# XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy)","= \" op=%d\" % i return repr(graph) + blk + opid def flowin(self,","s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link:","s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i","the block have bindings but we # still have to consider all the","frozen policy added_blocks\"\"\".split() ret = self.__dict__.copy() for key, value in ret.items(): if key","self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph","self.annotated = {} # set of blocks already seen self.added_blocks = None #","tuple): self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self, graph, link,","arg.annotation = s_value def warning(self, msg, pos=None): if pos is None: try: pos","= whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a","Variable or Constant.\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value)","= getattr( block.exitswitch.annotation, \"knowntypedata\", {}) else: knowntypedata = {} for link in exits:","resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the","raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError is","def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation","if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \"\"\"Check that the annotation results","blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph)","return self.binding(v) except KeyError: # the function didn't reach any return statement so","currently blocked, and that it should try to progress elsewhere.\"\"\" def __init__(self, annotator,","# make input arguments and set their type args_s = [self.typeannotation(t) for t","len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False #","from rpython.annotator import model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue,","for graph in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue)","can result in violations of the # more general results invariant: e.g. if","in block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some blocks are","'?': pos = self.whereami(pos) log.WARNING(\"%s/ %s\" % (pos, msg)) #___ interface for annotator.bookkeeper","the old # graph -- it's already low-level operations! for a, s_newarg in","engine that the situation is currently blocked, and that it should try to","block, done in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text","None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph, block): #","in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that","self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \"\"\"This exception signals the type inference engine that the situation","blocks _____________________ def processblock(self, graph, block): # Important: this is not called recursively.","annotations based on operations ______ def consider_op(self, op): # let's be careful about","the function didn't reach any return statement so far. # (some functions actually","return repr(graph) + blk + opid def flowin(self, graph, block): try: i =","has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if","graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None:","e: # note that UnionError is a subclass e.source = gather_error(self, graph, block,","# ignore the unannotated part #___ simplification (should be moved elsewhere?) _______ def","if block_subset is None: graphs = self.translator.graphs else: graphs = {} for block","def consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues # to","[link for link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op =","import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is None:","else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else:","got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block,","is None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def","Create the initial bindings for the input args of a block. assert len(block.inputargs)","annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v,","s_oldarg else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells)","log = AnsiLogger(\"annrpython\") class RPythonAnnotator(object): \"\"\"Block annotator for RPython. See description in doc/translation.txt.\"\"\"","self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v = graph.getreturnvar() try:","rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines)","s_constraint).improve() # ignore links that try to pass impossible values if s_out ==","from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from","{} # map {block: graph-containing-it} self.annotated = {} # set of blocks already","isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' %","three states: # * block not in self.annotated: # never seen the block.","link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and","policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete()","blk = \"\" if block: at = block.at() if at: blk = \"","self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily","(isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable):","cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph","in block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'):","= True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True","# generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current)","with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1]","constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s","the call operations in sync # with the flow object space. These are","unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v","import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph,","self.added_blocks is not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs =","# the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell)","\"?\" else: break_at = self.annotator.whereami(self.break_at) return \"<BlockedInference break_at %s [%s]>\" %(break_at, self.op) __str__","complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of","= graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't reach any","key not in attrs: assert type(value) is dict, ( \"%r is not dict.","op.result.annotation is None: break # ignore the unannotated part #___ simplification (should be","exits if the exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable):","= None self.op = op self.opindex = opindex def __repr__(self): if not self.break_at:","control flow graph variable, defaulting to 'object'.\"\"\" if isinstance(variable, Constant): return type(variable.value) elif","the annotation results are valid\"\"\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \"Gives the SomeValue corresponding","self.__dict__.copy() for key, value in ret.items(): if key not in attrs: assert type(value)","interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self","whence(self, graph) else: callback = whence callpositions[callback] = True # generalize the function's","merged cells changed, we must redo the analysis if unions != oldcells: self.bindinputargs(graph,","i += 1 except BlockedInference as e: if e.op is block.raising_op: # this","point into block with the given input cells.\"\"\" if graph in self.fixed_graphs: #","[]) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell =","in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self,","args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no","(key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface __________________ def","# with the flow object space. These are the operations for # which","s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const =","when this block is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback)","function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v","TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {}","impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming)","self.added_blocks = None # see processblock() below self.links_followed = {} # set of","in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for graph in","not contain %s\" % (s_value, s_old)) log.WARNING(\"%s\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation","get the (current) return value v = graph.getreturnvar() try: return self.binding(v) except KeyError:","renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of +=","# set of {blocked_block: (graph, index)} # --- the following information is recorded","{} # set of {blocked_block: (graph, index)} # --- the following information is","cases are problematic (but will hopefully be solved # later by reflowing). Throw","from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import","the given input cells.\"\"\" if graph in self.fixed_graphs: # special case for annotating/rtyping","= link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert","--- self.blocked_graphs = {} # set of graphs that have blocked blocks #","code removal: don't follow all exits if the exitswitch # is known exits","= self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s)","{} # set of blocks already seen self.added_blocks = None # see processblock()","e.source = '\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells changed,","pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?': pos","points to this func which triggers a reflow whenever the # return block","== len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False","import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import","policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is None: #"],"string":"[\n \"about the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import\",\n \"i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if\",\n \"for # which it is fine to always raise an exception. We then\",\n \"= self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase\",\n \"renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input\",\n \"if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for\",\n \"below self.links_followed = {} # set of links that have ever been followed\",\n \"(graph, None) def bindinputargs(self, graph, block, inputcells): # Create the initial bindings for\",\n \"self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved\",\n \"renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in\",\n \"exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits =\",\n \"to the given Variable or Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg,\",\n \"type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return\",\n \"is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom\",\n \"the known type of a control flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if\",\n \"= False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block,\",\n \"if op.opname in ('simple_call', 'call_args'): yield op # some blocks are partially annotated\",\n \"def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException))\",\n \"= \\\" block\\\"+at opid=\\\"\\\" if i is not None: opid = \\\" op=%d\\\"\",\n \"zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph,\",\n \"= graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference\",\n \"blocks are partially annotated if op.result.annotation is None: break # ignore the unannotated\",\n \"source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform from\",\n \"simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None:\",\n \"the type inference engine that the situation is currently blocked, and that it\",\n \"link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if\",\n \"import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator\",\n \"The analysis of a block can be in three states: # * block\",\n \"to the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if the\",\n \"prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy\",\n \"which it is fine to always raise an exception. We then # swallow\",\n \"block.raising_op s_exception = self.get_exception(op) for link in exits: case = link.exitcase if case\",\n \"is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the\",\n \"SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) ->\",\n \"elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out,\",\n \"saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() #\",\n \"then # swallow the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container().\",\n \"= self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s)\",\n \"will hopefully be solved # later by reflowing). Throw the BlockedInference up to\",\n \"we must generalize the # input variables). #print '* processblock', block, cells self.annotated[block]\",\n \"graphs not to annotate again self.blocked_blocks = {} # set of {blocked_block: (graph,\",\n \"Safety-check the new # annotations that are passed in, and don't annotate the\",\n \"def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not None: if\",\n \"newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False\",\n \"# boom -- in the assert of setbinding() for arg in op.args: if\",\n \"block have bindings but we # still have to consider all the operations\",\n \"elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name of\",\n \"function didn't reach any return statement so far. # (some functions actually never\",\n \"None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances()\",\n \"an exception handler. We then only follow the exceptional # branches. exits =\",\n \"self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy\",\n \"in sync # with the flow object space. These are the operations for\",\n \"self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if\",\n \"exceptional # branches. exits = [link for link in block.exits if link.exitcase is\",\n \"{}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow from certain positions\",\n \"raise else: # dead code removal: don't follow all exits if the exitswitch\",\n \"checkgraph from rpython.translator import simplify, transform from rpython.annotator import model as annmodel, signature\",\n \"specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy\",\n \"self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block not\",\n \"= [block for block, done in self.annotated.items() if done is False] assert len(blocked_blocks)\",\n \"%s\\\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence,\",\n \"self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False # must re-flow\",\n \"to this func which triggers a reflow whenever the # return block of\",\n \"self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception\",\n \"bindinputargs(self, graph, block, inputcells): # Create the initial bindings for the input args\",\n \"will # always raise an exception which is immediately caught by # an\",\n \"annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at\",\n \"if at: blk = \\\" block\\\"+at opid=\\\"\\\" if i is not None: opid\",\n \"SomeBool(const=False) ... # boom -- in the assert of setbinding() for arg in\",\n \"flowin(self, graph, block): try: i = 0 while i < len(block.operations): op =\",\n \"Throw the BlockedInference up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked:\",\n \"graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None:\",\n \"if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in exits: case\",\n \"else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph,\",\n \"keep the name of the call operations in sync # with the flow\",\n \"complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {}\",\n \"renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell\",\n \"of the block will # always raise an exception which is immediately caught\",\n \"with the given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special case for\",\n \"op # some blocks are partially annotated if op.result.annotation is None: break #\",\n \"graph-containing-it} self.annotated = {} # set of blocks already seen self.added_blocks = None\",\n \"given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special case for annotating/rtyping in\",\n \"difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else:\",\n \"v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value]))\",\n \"pending blocks until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks:\",\n \"!= oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of\",\n \"op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise\",\n \"in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] =\",\n \"= {} for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] =\",\n \"self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list)\",\n \"in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks =\",\n \"is dict, ( \\\"%r is not dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__))\",\n \"if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value\",\n \"c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to\",\n \"in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block]\",\n \"knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {} for link in\",\n \"in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert\",\n \"dict, ( \\\"%r is not dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key]\",\n \"newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return\",\n \"self.break_at: break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s [%s]>\\\"\",\n \"try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None):\",\n \"{}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception,\",\n \"def binding(self, arg): \\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\"\",\n \"new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if\",\n \"have bindings but we # still have to consider all the operations in\",\n \"False in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False\",\n \"= operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception):\",\n \"if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy\",\n \"except Exception as e: # hack for debug tools only if not hasattr(e,\",\n \"= False in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks =\",\n \"if op.result.annotation is None: break # ignore the unannotated part #___ simplification (should\",\n \"call operations in sync # with the flow object space. These are the\",\n \"v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out)\",\n \"more general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) ->\",\n \"the annotation for all exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self)\",\n \"exits = [link for link in block.exits if link.exitcase is not None] elif\",\n \"if resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self,\",\n \"block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert\",\n \"whereami(self, position_key): graph, block, i = position_key blk = \\\"\\\" if block: at\",\n \"# annotations that are passed in, and don't annotate the old # graph\",\n \"try: self.added_blocks = {} self.complete() # invoke annotation simplifications for the new blocks\",\n \"s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in\",\n \"self.added_blocks = {} self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks)\",\n \"isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or\",\n \"new 'cells' with each of the block's existing input # variables. oldcells =\",\n \"block.at() if at: blk = \\\" block\\\"+at opid=\\\"\\\" if i is not None:\",\n \"an exception. We then # swallow the BlockedInference and that's it. # About\",\n \"input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific entry point.\\\"\\\"\\\" assert isinstance(function,\",\n \"in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs = renaming.get(v,\",\n \"name of the call operations in sync # with the flow object space.\",\n \"None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result op =\",\n \"self.blocked_graphs = {} # set of graphs that have blocked blocks # ---\",\n \"break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph,\",\n \"# Add source code to the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True))\",\n \"= position_key blk = \\\"\\\" if block: at = block.at() if at: blk\",\n \"simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________\",\n \"from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator\",\n \"for block in newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'):\",\n \"continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference\",\n \"self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block is left if\",\n \"try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e:\",\n \"== len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in\",\n \"== s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell,\",\n \"typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out)\",\n \"or Constant expected, got %r' % (arg,)) def binding(self, arg): \\\"Gives the SomeValue\",\n \"self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args,\",\n \"= policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def\",\n \"= None # see processblock() below self.links_followed = {} # set of links\",\n \"= self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally:\",\n \"entry point into block with the given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs:\",\n \"SomeValue corresponding to the given Variable or Constant.\\\" if isinstance(arg, Variable): return arg.annotation\",\n \"# graph -- it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells):\",\n \"bind resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\" Return the annotation for all\",\n \"#___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple):\",\n \"dead code removal: don't follow all exits if the exitswitch # is known\",\n \"notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value in ret.items():\",\n \"type(value) is dict, ( \\\"%r is not dict. please update %s.__getstate__\\\" % (key,\",\n \"None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos !=\",\n \"# processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e:\",\n \"model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference)\",\n \"if whence is not None: if callable(whence): def callback(): whence(self, graph) else: callback\",\n \"the operations in the block. # * self.annotated[block] == graph-containing-block: # analysis done\",\n \"for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must\",\n \"it. # About 'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic\",\n \"op = block.raising_op s_exception = self.get_exception(op) for link in exits: case = link.exitcase\",\n \"block. # * self.annotated[block] == False: # the input variables of the block\",\n \"the new 'cells' with each of the block's existing input # variables. oldcells\",\n \"op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at =\",\n \"\\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\" if isinstance(arg, Variable):\",\n \"renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint\",\n \"BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return else: # other\",\n \"unannotated part #___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None):\",\n \"s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self):\",\n \"\\\"knowntypedata\\\", {}) else: knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase,\",\n \"that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and\",\n \"\\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self,\",\n \"#print '* processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks: del\",\n \"link, {}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc =\",\n \"position else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type))\",\n \"op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops: continue\",\n \"elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key\",\n \"pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key,\",\n \"not in attrs: assert type(value) is dict, ( \\\"%r is not dict. please\",\n \"key, value in ret.items(): if key not in attrs: assert type(value) is dict,\",\n \"'?' if pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg))\",\n \"case = link.exitcase if case is None: self.follow_link(graph, link, {}) continue if s_exception\",\n \"'__annotator_block', block) raise # The dict 'added_blocks' is used by rpython.annlowlevel to #\",\n \"link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in\",\n \"link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out\",\n \"invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved\",\n \"callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def callback():\",\n \"annmodel.AnnotatorError as e: # note that UnionError is a subclass e.source = gather_error(self,\",\n \"difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class\",\n \"self.bookkeeper = bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper\",\n \"only follow the exceptional # branches. exits = [link for link in block.exits\",\n \"annotate again self.blocked_blocks = {} # set of {blocked_block: (graph, index)} # ---\",\n \"op.opname in ('simple_call', 'call_args'): yield op # some blocks are partially annotated if\",\n \"extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs =\",\n \"if i is not None: opid = \\\" op=%d\\\" % i return repr(graph)\",\n \"dictionary of call # points to this func which triggers a reflow whenever\",\n \"for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code\",\n \"= AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def\",\n \"graph, block, i) raise else: # dead code removal: don't follow all exits\",\n \"part #___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): #\",\n \"try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False # failed, hopefully\",\n \"newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out,\",\n \"s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out)\",\n \"= {} self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally:\",\n \"do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index\",\n \"self.annotation(arg) if s_arg is None: raise KeyError return s_arg def typeannotation(self, t): return\",\n \"False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells):\",\n \"getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {} for link in exits: constraints\",\n \"a control flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value)\",\n \"t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old\",\n \"\\\"\\\"\\\"Register an entry point into block with the given input cells.\\\"\\\"\\\" if graph\",\n \"% (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface __________________\",\n \"try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?':\",\n \"exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch)\",\n \"( \\\"%r is not dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] =\",\n \"oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of =\",\n \"that it should try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator\",\n \"have blocked blocks # --- end of debugging information --- self.frozen = False\",\n \"Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant\",\n \"# always raise an exception which is immediately caught by # an exception\",\n \"always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key\",\n \"newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i = position_key blk\",\n \"opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None\",\n \"i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError\",\n \"block will # always raise an exception which is immediately caught by #\",\n \"zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out in\",\n \"op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell\",\n \"if not self.break_at: break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at\",\n \"to # detect which are the new blocks that annotating an additional #\",\n \"e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except\",\n \"op): # let's be careful about avoiding propagated SomeImpossibleValues # to enter an\",\n \"changed, we must redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions)\",\n \"exception. We then # swallow the BlockedInference and that's it. # About 'next':\",\n \"this func which triggers a reflow whenever the # return block of this\",\n \"None: if callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback] =\",\n \"link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints:\",\n \"if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e:\",\n \"BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable):\",\n \"the (current) return value v = graph.getreturnvar() try: return self.binding(v) except KeyError: #\",\n \"e: # Add source code to the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None,\",\n \"simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self,\",\n \"sure that the return variables of all graphs is annotated if self.added_blocks is\",\n \"def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process\",\n \"be in three states: # * block not in self.annotated: # never seen\",\n \"reflowing). Throw the BlockedInference up to # processblock(). e.opindex = i raise except\",\n \"def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except\",\n \"s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old =\",\n \"consider all the operations in the block. # * self.annotated[block] == graph-containing-block: #\",\n \"convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations\",\n \"flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry\",\n \"block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): #\",\n \"of all graphs is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block]\",\n \"list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells):\",\n \"op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if e.op\",\n \"def flowin(self, graph, block): try: i = 0 while i < len(block.operations): op\",\n \"= self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy =\",\n \"self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper =\",\n \"= annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex = opindex\",\n \"# set of blocks already seen self.added_blocks = None # see processblock() below\",\n \"{} # set of graphs not to annotate again self.blocked_blocks = {} #\",\n \"recorded for debugging --- self.blocked_graphs = {} # set of graphs that have\",\n \"self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs())\",\n \"and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s\",\n \"variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable\",\n \"in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in\",\n \"block, cells): \\\"\\\"\\\"Register an entry point into block with the given input cells.\\\"\\\"\\\"\",\n \"The dict 'added_blocks' is used by rpython.annlowlevel to # detect which are the\",\n \"already seen self.added_blocks = None # see processblock() below self.links_followed = {} #\",\n \"triggers a reflow whenever the # return block of this graph has been\",\n \"\\\" op=%d\\\" % i return repr(graph) + blk + opid def flowin(self, graph,\",\n \"absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype\",\n \"complete(self): \\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if\",\n \"self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False # must\",\n \"= True blocked_blocks = [block for block, done in self.annotated.items() if done is\",\n \"translator.annotator = self self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it}\",\n \"= defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in\",\n \"graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is\",\n \"We then only follow the exceptional # branches. exits = [link for link\",\n \"is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" % (s_value,\",\n \"def __repr__(self): if not self.break_at: break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return\",\n \"newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op #\",\n \"the case where the last operation of the block will # always raise\",\n \"= ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph =\",\n \"later by reflowing). Throw the BlockedInference up to # processblock(). e.opindex = i\",\n \"a subclass e.source = gather_error(self, graph, block, i) raise else: # dead code\",\n \"except AttributeError: pos = '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/\",\n \"{} # set of graphs that have blocked blocks # --- end of\",\n \"policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells =\",\n \"# XXX warning, keep the name of the call operations in sync #\",\n \"whence is not None: if callable(whence): def callback(): whence(self, graph) else: callback =\",\n \"graph, tag) # self.notify[graph.returnblock] is a dictionary of call # points to this\",\n \"None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name\",\n \"[] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out\",\n \"= self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def callback(): whence(self,\",\n \"is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known\",\n \"the block will # always raise an exception which is immediately caught by\",\n \"%s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value\",\n \"for debugging --- self.blocked_graphs = {} # set of graphs that have blocked\",\n \"to annotate again self.blocked_blocks = {} # set of {blocked_block: (graph, index)} #\",\n \"tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of\",\n \"all exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is\",\n \"= [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type\",\n \"block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the\",\n \"AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model\",\n \"AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self,\",\n \"ret[key] = {} return ret #___ convenience high-level interface __________________ def build_types(self, function,\",\n \"`operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception))\",\n \"# recursively proceed until no more pending block is left if complete_now: self.complete()\",\n \"% (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def\",\n \"self.op = op self.opindex = opindex def __repr__(self): if not self.break_at: break_at =\",\n \"s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits if\",\n \"SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation is\",\n \"arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v = graph.getreturnvar()\",\n \"s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i =\",\n \"block.raising_op: # this is the case where the last operation of the block\",\n \"Exception as e: # hack for debug tools only if not hasattr(e, '__annotator_block'):\",\n \"the name of the call operations in sync # with the flow object\",\n \"= typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const\",\n \"block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block]\",\n \"+ opid def flowin(self, graph, block): try: i = 0 while i <\",\n \"at: blk = \\\" block\\\"+at opid=\\\"\\\" if i is not None: opid =\",\n \"args of a block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs,\",\n \"until we find we must generalize the # input variables). #print '* processblock',\",\n \"ignore links that try to pass impossible values if s_out == s_ImpossibleValue: ignore_link\",\n \"renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is\",\n \"block, i = position_key blk = \\\"\\\" if block: at = block.at() if\",\n \"= defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args:\",\n \"link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False\",\n \"to self.addpendingblock(). # The analysis of a block can be in three states:\",\n \"the merged cells changed, we must redo the analysis if unions != oldcells:\",\n \"call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated # all\",\n \"self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations ______ def consider_op(self,\",\n \"= SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc)\",\n \"graph, block, i = position_key blk = \\\"\\\" if block: at = block.at()\",\n \"annotations about the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy\",\n \"main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy):\",\n \"= \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s [%s]>\\\" %(break_at, self.op)\",\n \"else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s [%s]>\\\" %(break_at, self.op) __str__ =\",\n \"arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain\",\n \"self.links_followed = {} # set of links that have ever been followed self.notify\",\n \"complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known type of a\",\n \"None) def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with each\",\n \"self.fixed_graphs = {} # set of graphs not to annotate again self.blocked_blocks =\",\n \"in the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise\",\n \"SomeValue corresponding to the given Variable or Constant.\\\" s_arg = self.annotation(arg) if s_arg\",\n \"block, cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph,\",\n \"def annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy\",\n \"annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None): if pos\",\n \"additional # small helper creates. if self.added_blocks is not None: self.added_blocks[block] = True\",\n \"else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata =\",\n \"policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function,\",\n \"{positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to annotate again self.blocked_blocks\",\n \"annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op\",\n \"arg, s_value): s_old = arg.annotation if s_old is not None: if not s_value.contains(s_old):\",\n \"not None: if callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback]\",\n \"block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for\",\n \"exits = [link for link in exits if link.exitcase == s_exitswitch.const] if block.canraise:\",\n \"def bindinputargs(self, graph, block, inputcells): # Create the initial bindings for the input\",\n \"nbarg # wrong number of args # register the entry point self.addpendinggraph(flowgraph, inputcells)\",\n \"self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper\",\n \"desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s)\",\n \"return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try:\",\n \"in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant):\",\n \"annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def\",\n \"def whereami(self, position_key): graph, block, i = position_key blk = \\\"\\\" if block:\",\n \"debugging information --- self.frozen = False if policy is None: from rpython.annotator.policy import\",\n \"new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result =\",\n \"operations in sync # with the flow object space. These are the operations\",\n \"ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock,\",\n \"self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None:\",\n \"never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block,\",\n \"v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v]\",\n \"= self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def\",\n \"( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return\",\n \"# never seen the block. # * self.annotated[block] == False: # the input\",\n \"= True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception\",\n \"None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) #\",\n \"'next'): # XXX warning, keep the name of the call operations in sync\",\n \"__________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific\",\n \"for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool()\",\n \"new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if e.op is block.raising_op:\",\n \"signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import\",\n \"then only follow the exceptional # branches. exits = [link for link in\",\n \"seen the block. # * self.annotated[block] == False: # the input variables of\",\n \"self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated\",\n \"newblocks = self.annotated # all of them for block in newblocks: for op\",\n \"in ('simple_call', 'call_args'): yield op # some blocks are partially annotated if op.result.annotation\",\n \"graph = self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph)\",\n \"* self.annotated[block] == graph-containing-block: # analysis done (at least until we find we\",\n \"args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy()\",\n \"policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() #\",\n \"= {} # map {block: graph-containing-it} self.annotated = {} # set of blocks\",\n \"so far. # (some functions actually never do, they always raise exceptions) return\",\n \"in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out ==\",\n \"of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph,\",\n \"= {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s\",\n \"the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return else: #\",\n \"in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None) def\",\n \"self.opindex = opindex def __repr__(self): if not self.break_at: break_at = \\\"?\\\" else: break_at\",\n \"ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} #\",\n \"parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call # points\",\n \"def validate(self): \\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg):\",\n \"annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value\",\n \"links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value in\",\n \"the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block\",\n \"else: self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper =\",\n \"if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else:\",\n \"recursively proceed until no more pending block is left if complete_now: self.complete() return\",\n \"translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {} #\",\n \"reach any return statement so far. # (some functions actually never do, they\",\n \"= s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const\",\n \"certain positions when this block is done for callback in self.notify[block]: if isinstance(callback,\",\n \"\\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the\",\n \"s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None): if pos is\",\n \"more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable):\",\n \"# the function didn't reach any return statement so far. # (some functions\",\n \"must redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self,\",\n \"= True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self)\",\n \"AttributeError: pos = '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\"\",\n \"cells): \\\"\\\"\\\"Register an entry point into block with the given input cells.\\\"\\\"\\\" if\",\n \"with each of the block's existing input # variables. oldcells = [self.binding(a) for\",\n \"import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls\",\n \"\\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs\",\n \"self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not\",\n \"have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {}\",\n \"if pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___\",\n \"# The analysis of a block can be in three states: # *\",\n \"= [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for\",\n \"SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log =\",\n \"(types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming =\",\n \"= graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def\",\n \"len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] =\",\n \"variables of the block have bindings but we # still have to consider\",\n \"# register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more\",\n \"True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure that\",\n \"of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values():\",\n \"in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False #\",\n \"isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return\",\n \"s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in exits:\",\n \"link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception\",\n \"annotating/rtyping in several phases: calling # a graph that has already been rtyped.\",\n \"s_out = pair(s_out, s_constraint).improve() # ignore links that try to pass impossible values\",\n \"arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got\",\n \"self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?': pos = self.whereami(pos)\",\n \"hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {}\",\n \"not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen assert\",\n \"rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable,\",\n \"\\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw)\",\n \"# swallow the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return\",\n \"False inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs):\",\n \"already been rtyped. Safety-check the new # annotations that are passed in, and\",\n \"v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation results are\",\n \"graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks\",\n \"else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while\",\n \"interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph,\",\n \"build annotations about the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from\",\n \"block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for graph\",\n \"the new # annotations that are passed in, and don't annotate the old\",\n \"rpython.annlowlevel to # detect which are the new blocks that annotating an additional\",\n \"find we must generalize the # input variables). #print '* processblock', block, cells\",\n \"Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits\",\n \"pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if\",\n \"None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\"\",\n \"is None: break # ignore the unannotated part #___ simplification (should be moved\",\n \"rpython.annotator import model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance,\",\n \"flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function)\",\n \"case where the last operation of the block will # always raise an\",\n \"'\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells changed, we must\",\n \"args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved =\",\n \"flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the\",\n \"% (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells):\",\n \"zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to the UnionError e.source\",\n \"self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if\",\n \"We then # swallow the BlockedInference and that's it. # About 'next': see\",\n \"is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul\",\n \"for link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op\",\n \"from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object):\",\n \"if e.op is block.raising_op: # this is the case where the last operation\",\n \"follow the exceptional # branches. exits = [link for link in block.exits if\",\n \"__init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError:\",\n \"graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type))\",\n \"typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if\",\n \"in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError\",\n \"UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells\",\n \"# input variables). #print '* processblock', block, cells self.annotated[block] = graph if block\",\n \"point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block is left\",\n \"== s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in\",\n \"is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case =\",\n \"elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object\",\n \"other cases are problematic (but will hopefully be solved # later by reflowing).\",\n \"self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self,\",\n \"input variables of the block have bindings but we # still have to\",\n \"resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell ==\",\n \"test_annotate_iter_empty_container(). return else: # other cases are problematic (but will hopefully be solved\",\n \"removal: don't follow all exits if the exitswitch # is known exits =\",\n \"update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level\",\n \"set of graphs that have blocked blocks # --- end of debugging information\",\n \"is block.raising_op: # this is the case where the last operation of the\",\n \"are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue corresponding to the given\",\n \"for link in exits: case = link.exitcase if case is None: self.follow_link(graph, link,\",\n \"for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some\",\n \"{} for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True\",\n \"# invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks =\",\n \"build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg #\",\n \"op=%d\\\" % i return repr(graph) + blk + opid def flowin(self, graph, block):\",\n \"of {blocked_block: (graph, index)} # --- the following information is recorded for debugging\",\n \"= [link for link in block.exits if link.exitcase is not None] elif e.op.opname\",\n \"blocks that annotating an additional # small helper creates. if self.added_blocks is not\",\n \"consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues # to enter\",\n \"set of graphs not to annotate again self.blocked_blocks = {} # set of\",\n \"self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None) def\",\n \"graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link =\",\n \"# interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator =\",\n \"= s_value def warning(self, msg, pos=None): if pos is None: try: pos =\",\n \"== False: # the input variables of the block have bindings but we\",\n \"e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None),\",\n \"isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell\",\n \"self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() # invoke annotation\",\n \"isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def\",\n \"e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note\",\n \"s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch,\",\n \"of links that have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}}\",\n \"variables). #print '* processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks:\",\n \"Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise\",\n \"XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if\",\n \"None: newblocks = self.annotated # all of them for block in newblocks: for\",\n \"-- it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg =\",\n \"... # boom -- in the assert of setbinding() for arg in op.args:\",\n \"of blocks already seen self.added_blocks = None # see processblock() below self.links_followed =\",\n \"of call # points to this func which triggers a reflow whenever the\",\n \"= newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i = position_key\",\n \"is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell\",\n \"self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False\",\n \"none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished\",\n \"input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s,\",\n \"(but will hopefully be solved # later by reflowing). Throw the BlockedInference up\",\n \"the input variables of the block have bindings but we # still have\",\n \"s_arg is None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper)\",\n \"the given Variable or Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant):\",\n \"operation of the block will # always raise an exception which is immediately\",\n \"= difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {})\",\n \"far. # (some functions actually never do, they always raise exceptions) return s_ImpossibleValue\",\n \"= {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not\",\n \"Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\" Return\",\n \"s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot\",\n \"BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list) for v_out, v_input\",\n \"newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all\",\n \"%s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface\",\n \"self.fixed_graphs: # special case for annotating/rtyping in several phases: calling # a graph\",\n \"reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks =\",\n \"TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {} # map {block:\",\n \"policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications for the new\",\n \"op; the latter can result in violations of the # more general results\",\n \"graphs that have blocked blocks # --- end of debugging information --- self.frozen\",\n \"if s_old is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\"\",\n \"s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if\",\n \"raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None: resultcell =\",\n \"block with the given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special case\",\n \"= self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the\",\n \"least until we find we must generalize the # input variables). #print '*\",\n \"while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure\",\n \"is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise\",\n \"__repr__(self): if not self.break_at: break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference\",\n \"link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type\",\n \"try to pass impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out\",\n \"is None: newblocks = self.annotated # all of them for block in newblocks:\",\n \"\\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments\",\n \"else: # other cases are problematic (but will hopefully be solved # later\",\n \"s_old is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" %\",\n \"e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name of the\",\n \"by reflowing). Throw the BlockedInference up to # processblock(). e.opindex = i raise\",\n \"raise TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self, arg): \\\"Gives\",\n \"done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a\",\n \"self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations\",\n \"simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications\",\n \"= AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function,\",\n \"len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args # register the\",\n \"self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\" while\",\n \"in three states: # * block not in self.annotated: # never seen the\",\n \"input # variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions =\",\n \"no more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self,\",\n \"link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const =\",\n \"to op.result def get_exception(self, operation): \\\"\\\"\\\" Return the annotation for all exceptions that\",\n \"resultcell) # bind resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\" Return the annotation\",\n \"a block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a,\",\n \"of the block's existing input # variables. oldcells = [self.binding(a) for a in\",\n \"gather_error(self, graph, block, i) raise else: # dead code removal: don't follow all\",\n \"self.follow_link(graph, link, constraints) if block in self.notify: # reflow from certain positions when\",\n \"if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs\",\n \"small helper creates. if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self,\",\n \"self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave()\",\n \"self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self,\",\n \"re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): # Create the\",\n \"v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const\",\n \"analysis of a block can be in three states: # * block not\",\n \"v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if\",\n \"inputcells) # get the (current) return value v = graph.getreturnvar() try: return self.binding(v)\",\n \"= format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v =\",\n \"self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry point into\",\n \"cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell\",\n \"for the input args of a block. assert len(block.inputargs) == len(inputcells) for a,\",\n \"renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const\",\n \"always raise an exception. We then # swallow the BlockedInference and that's it.\",\n \"value in ret.items(): if key not in attrs: assert type(value) is dict, (\",\n \"return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' % (arg,)) def\",\n \"translator is None: # interface for tests from rpython.translator.translator import TranslationContext translator =\",\n \"log.WARNING(\\\"%s does not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert\",\n \"long=True)) raise # if the merged cells changed, we must redo the analysis\",\n \"in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects\",\n \"type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list)\",\n \"simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs\",\n \"bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated\",\n \"link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out =\",\n \"finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg =\",\n \"else: raise TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got %r\\\" % (variable,)) def\",\n \"# (some functions actually never do, they always raise exceptions) return s_ImpossibleValue def\",\n \"Constant instance expected, \\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list\",\n \"assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation):\",\n \"raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph,\",\n \"self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def\",\n \"== graph-containing-block: # analysis done (at least until we find we must generalize\",\n \"type inference engine that the situation is currently blocked, and that it should\",\n \"if graph in self.fixed_graphs: # special case for annotating/rtyping in several phases: calling\",\n \"self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph,\",\n \"= '\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells changed, we\",\n \"self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks:\",\n \"new blocks that annotating an additional # small helper creates. if self.added_blocks is\",\n \"links that have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs\",\n \"c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to the\",\n \"self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc\",\n \"op.result def get_exception(self, operation): \\\"\\\"\\\" Return the annotation for all exceptions that `operation`\",\n \"= [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul)\",\n \"block, inputcells): # Merge the new 'cells' with each of the block's existing\",\n \"or Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else:\",\n \"or Constant.\\\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError return s_arg\",\n \"self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call # points to\",\n \"is a position else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase,\",\n \"# Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs\",\n \"self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks\",\n \"annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex = opindex def\",\n \"the SomeValue corresponding to the given Variable or Constant.\\\" if isinstance(arg, Variable): return\",\n \"is None: graphs = self.translator.graphs else: graphs = {} for block in block_subset:\",\n \"op, -1) resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif\",\n \"flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph,\",\n \"graph in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def\",\n \"not in self.annotated: # never seen the block. # * self.annotated[block] == False:\",\n \"'call_args'): yield op # some blocks are partially annotated if op.result.annotation is None:\",\n \"if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link\",\n \"if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None)\",\n \"whenever the # return block of this graph has been analysed. callpositions =\",\n \"# small helper creates. if self.added_blocks is not None: self.added_blocks[block] = True def\",\n \"for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell =\",\n \"_____________________ def processblock(self, graph, block): # Important: this is not called recursively. #\",\n \"whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block,\",\n \"we # still have to consider all the operations in the block. #\",\n \"hopefully be solved # later by reflowing). Throw the BlockedInference up to #\",\n \"+= 1 except BlockedInference as e: if e.op is block.raising_op: # this is\",\n \"[self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs\",\n \"graphs = {} for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph]\",\n \"s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg,\",\n \"False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else:\",\n \"from rpython.translator import simplify, transform from rpython.annotator import model as annmodel, signature from\",\n \"assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for\",\n \"return value v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the function\",\n \"return except annmodel.AnnotatorError as e: # note that UnionError is a subclass e.source\",\n \"analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def\",\n \"detect which are the new blocks that annotating an additional # small helper\",\n \"About 'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic (but will\",\n \"try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator = annotator try:\",\n \"rpython.rtyper.extfuncregistry # has side effects if translator is None: # interface for tests\",\n \"def annotation(self, arg): \\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\"\",\n \"if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is\",\n \"signals the type inference engine that the situation is currently blocked, and that\",\n \"AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper\",\n \"1 except BlockedInference as e: if e.op is block.raising_op: # this is the\",\n \"s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old))\",\n \"s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation,\",\n \"= knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow from\",\n \"calls to self.addpendingblock(). # The analysis of a block can be in three\",\n \"known type of a control flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable,\",\n \"boom -- in the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg),\",\n \"result in violations of the # more general results invariant: e.g. if SomeImpossibleValue\",\n \"dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all of them\",\n \"inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self,\",\n \"setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell\",\n \"if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s,\",\n \"new # annotations that are passed in, and don't annotate the old #\",\n \"if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore\",\n \"def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator\",\n \"given Variable or Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return\",\n \"block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for\",\n \"blocks already seen self.added_blocks = None # see processblock() below self.links_followed = {}\",\n \"= {} for v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v\",\n \"graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks until none is\",\n \"e.op is block.raising_op: # this is the case where the last operation of\",\n \"ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively\",\n \"# special case for annotating/rtyping in several phases: calling # a graph that\",\n \"not to annotate again self.blocked_blocks = {} # set of {blocked_block: (graph, index)}\",\n \"the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells,\",\n \"main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix\",\n \"see test_annotate_iter_empty_container(). return else: # other cases are problematic (but will hopefully be\",\n \"annotation(self, arg): \\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\" if\",\n \"continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case)\",\n \"Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype\",\n \"RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None,\",\n \"= '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos,\",\n \"last operation of the block will # always raise an exception which is\",\n \"rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from\",\n \"False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text)\",\n \"annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for block in self.added_blocks]\",\n \"block) except BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block]\",\n \"register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending\",\n \"self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self, graph, link, constraints):\",\n \"block): try: i = 0 while i < len(block.operations): op = block.operations[i] with\",\n \"class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference engine that the situation is\",\n \"block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs = {}\",\n \"renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v,\",\n \"exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op)\",\n \"that the return variables of all graphs is annotated if self.added_blocks is not\",\n \"else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and\",\n \"inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert\",\n \"= bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen\",\n \"self.break_at = None self.op = op self.opindex = opindex def __repr__(self): if not\",\n \"# * self.annotated[block] == graph-containing-block: # analysis done (at least until we find\",\n \"block, None, long=True)) raise # if the merged cells changed, we must redo\",\n \"for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out =\",\n \"if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self,\",\n \"rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is\",\n \"\\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\" s_arg = self.annotation(arg)\",\n \"flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable,\",\n \"them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph]\",\n \"func which triggers a reflow whenever the # return block of this graph\",\n \"graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in\",\n \"= gather_error(self, graph, block, i) raise else: # dead code removal: don't follow\",\n \"None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom --\",\n \"and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if\",\n \"self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications\",\n \"nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args #\",\n \"is None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos\",\n \"v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type,\",\n \"ignore_link = False inputs_s = [] renaming = defaultdict(list) for v_out, v_input in\",\n \"cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self,\",\n \"a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph,\",\n \"self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure that the\",\n \"{blocked_block: (graph, index)} # --- the following information is recorded for debugging ---\",\n \"return ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False):\",\n \"else: raise TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self, arg):\",\n \"link, constraints) if block in self.notify: # reflow from certain positions when this\",\n \"cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special case for annotating/rtyping in several phases:\",\n \"\\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for\",\n \"newblocks is None: newblocks = self.annotated # all of them for block in\",\n \"self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue corresponding to the given Variable or\",\n \"# self.notify[graph.returnblock] is a dictionary of call # points to this func which\",\n \"may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else:\",\n \"while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops =\",\n \"debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The\",\n \"{} for v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v in\",\n \"general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool\",\n \"arguments and set their type args_s = [self.typeannotation(t) for t in input_arg_types] #\",\n \"not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] = False\",\n \"isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\"\",\n \"# Create the initial bindings for the input args of a block. assert\",\n \"desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy\",\n \"self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): # Create the initial\",\n \"not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]:\",\n \"return variables of all graphs is annotated if self.added_blocks is not None: newgraphs\",\n \"BlockedInference up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except\",\n \"block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None)\",\n \"succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to\",\n \"added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value in ret.items(): if key not in\",\n \"# branches. exits = [link for link in block.exits if link.exitcase is not\",\n \"isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming\",\n \"operations ______ def consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues\",\n \"s_value def warning(self, msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key\",\n \"0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops\",\n \"= block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link\",\n \"input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special case for annotating/rtyping in several\",\n \"is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\"\",\n \"# if the merged cells changed, we must redo the analysis if unions\",\n \"processblock() below self.links_followed = {} # set of links that have ever been\",\n \"= whence callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock,\",\n \"still have to consider all the operations in the block. # * self.annotated[block]\",\n \"= self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve()\",\n \"branches. exits = [link for link in block.exits if link.exitcase is not None]\",\n \"interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the\",\n \"break # ignore the unannotated part #___ simplification (should be moved elsewhere?) _______\",\n \"constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try to pass impossible\",\n \"return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old\",\n \"# still have to consider all the operations in the block. # *\",\n \"mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with each of the\",\n \"propagated SomeImpossibleValues # to enter an op; the latter can result in violations\",\n \"assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value,\",\n \"-> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in\",\n \"is not None: if callable(whence): def callback(): whence(self, graph) else: callback = whence\",\n \"op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable)\",\n \"= i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that\",\n \"issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list) for v_out,\",\n \"map {block: graph-containing-it} self.annotated = {} # set of blocks already seen self.added_blocks\",\n \"v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out]\",\n \"graph in self.fixed_graphs: # special case for annotating/rtyping in several phases: calling #\",\n \"the last operation of the block will # always raise an exception which\",\n \"SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in the\",\n \"= {} # set of graphs that have blocked blocks # --- end\",\n \"build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific entry point.\\\"\\\"\\\"\",\n \"s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata\",\n \"(isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming\",\n \"v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if\",\n \"'call_args', 'next'): # XXX warning, keep the name of the call operations in\",\n \"resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed assert\",\n \"True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the\",\n \"return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected,\",\n \"only issue calls to self.addpendingblock(). # The analysis of a block can be\",\n \"sync # with the flow object space. These are the operations for #\",\n \"calling # a graph that has already been rtyped. Safety-check the new #\",\n \"flowing annotations in blocks _____________________ def processblock(self, graph, block): # Important: this is\",\n \"rpython.translator import simplify, transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model\",\n \"inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index\",\n \"in ret.items(): if key not in attrs: assert type(value) is dict, ( \\\"%r\",\n \"in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant():\",\n \"into block with the given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special\",\n \"for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise #\",\n \"graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation\",\n \"must generalize the # input variables). #print '* processblock', block, cells self.annotated[block] =\",\n \"it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a)\",\n \"s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of\",\n \"v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of)\",\n \"log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph,\",\n \"def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific entry\",\n \"BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference engine that the situation is currently\",\n \"the block's existing input # variables. oldcells = [self.binding(a) for a in block.inputargs]\",\n \"analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if\",\n \"to the given Variable or Constant.\\\" s_arg = self.annotation(arg) if s_arg is None:\",\n \"variable): \\\"\\\"\\\"Return the known type of a control flow graph variable, defaulting to\",\n \"an op; the latter can result in violations of the # more general\",\n \"return object else: raise TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got %r\\\" %\",\n \"special case for annotating/rtyping in several phases: calling # a graph that has\",\n \"# points to this func which triggers a reflow whenever the # return\",\n \"self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except\",\n \"passed in, and don't annotate the old # graph -- it's already low-level\",\n \"self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy =\",\n \"corresponding to the given Variable or Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif\",\n \"return statement so far. # (some functions actually never do, they always raise\",\n \"inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None)\",\n \"left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make\",\n \"# detect which are the new blocks that annotating an additional # small\",\n \"entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no more pending block is\",\n \"value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs\",\n \"from __future__ import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import\",\n \"is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator\",\n \"a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin.\",\n \"return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def\",\n \"bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy\",\n \"a dictionary of call # points to this func which triggers a reflow\",\n \"BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue\",\n \"corresponding to the given Variable or Constant.\\\" s_arg = self.annotation(arg) if s_arg is\",\n \"a reflow whenever the # return block of this graph has been analysed.\",\n \"if new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result\",\n \"self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks until\",\n \"the return variables of all graphs is annotated if self.added_blocks is not None:\",\n \"of a block can be in three states: # * block not in\",\n \"len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops\",\n \"inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s,\",\n \"self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata =\",\n \"block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks\",\n \"inputcells): # Merge the new 'cells' with each of the block's existing input\",\n \"whence callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells)\",\n \"been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence):\",\n \"to consider all the operations in the block. # * self.annotated[block] == graph-containing-block:\",\n \"the # more general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue,\",\n \"Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for\",\n \"raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg,\",\n \"if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is\",\n \"if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self,\",\n \"caught by # an exception handler. We then only follow the exceptional #\",\n \"assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block]\",\n \"graph assert block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] =\",\n \"# return block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {})\",\n \"True blocked_blocks = [block for block, done in self.annotated.items() if done is False]\",\n \"args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = (\",\n \"return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type\",\n \"parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock]\",\n \"violations of the # more general results invariant: e.g. if SomeImpossibleValue enters is_\",\n \"(at least until we find we must generalize the # input variables). #print\",\n \"self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback() def\",\n \"# --- the following information is recorded for debugging --- self.blocked_graphs = {}\",\n \"been rtyped. Safety-check the new # annotations that are passed in, and don't\",\n \"raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation is None:\",\n \"we find we must generalize the # input variables). #print '* processblock', block,\",\n \"the following information is recorded for debugging --- self.blocked_graphs = {} # set\",\n \"return else: # other cases are problematic (but will hopefully be solved #\",\n \"known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits\",\n \"#___ creating the annotations based on operations ______ def consider_op(self, op): # let's\",\n \"-1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result,\",\n \"that has already been rtyped. Safety-check the new # annotations that are passed\",\n \"where the last operation of the block will # always raise an exception\",\n \"solved # later by reflowing). Throw the BlockedInference up to # processblock(). e.opindex\",\n \"assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out\",\n \"for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block\",\n \"can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class\",\n \"expected, \\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\"\",\n \"variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for\",\n \"= {} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints)\",\n \"oldcells = [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1,\",\n \"('simple_call', 'call_args'): yield op # some blocks are partially annotated if op.result.annotation is\",\n \"for block in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for\",\n \"self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] =\",\n \"exception signals the type inference engine that the situation is currently blocked, and\",\n \"link in exits: case = link.exitcase if case is None: self.follow_link(graph, link, {})\",\n \"{} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if\",\n \"Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' % (arg,))\",\n \"block, i) raise else: # dead code removal: don't follow all exits if\",\n \"fine to always raise an exception. We then # swallow the BlockedInference and\",\n \"# is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ... #\",\n \"the operations for # which it is fine to always raise an exception.\",\n \"= policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications for the\",\n \"else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference engine that\",\n \"flow object space. These are the operations for # which it is fine\",\n \"self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block\",\n \"the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self,\",\n \"annotation for all exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if\",\n \"blocked, and that it should try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op,\",\n \"else: knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph,\",\n \"= block.at() if at: blk = \\\" block\\\"+at opid=\\\"\\\" if i is not\",\n \"immediately caught by # an exception handler. We then only follow the exceptional\",\n \"< len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if\",\n \"block) raise # The dict 'added_blocks' is used by rpython.annlowlevel to # detect\",\n \"which triggers a reflow whenever the # return block of this graph has\",\n \"newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for\",\n \"progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at =\",\n \"newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value]\",\n \"block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs\",\n \"( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import\",\n \"s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs = renaming.get(v, [])\",\n \"s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out,\",\n \"self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex =\",\n \"(graph, index)} # --- the following information is recorded for debugging --- self.blocked_graphs\",\n \"the input args of a block. assert len(block.inputargs) == len(inputcells) for a, cell\",\n \"is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished #\",\n \"\\\"\\\"\\\"Return the known type of a control flow graph variable, defaulting to 'object'.\\\"\\\"\\\"\",\n \"renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs = renaming.get(v, []) for\",\n \"for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) ==\",\n \"newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks:\",\n \"# XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy)\",\n \"self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not None:\",\n \"def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase,\",\n \"hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells,\",\n \"= newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items():\",\n \"high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about\",\n \"block, i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops\",\n \"from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = (\",\n \"s_variable.knowntype else: return object else: raise TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got\",\n \"a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg\",\n \"callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback] = True #\",\n \"self.frozen = False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy =\",\n \"= self.annotated # all of them for block in newblocks: for op in\",\n \"s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant():\",\n \"s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject)\",\n \"if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {}\",\n \"if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known type of\",\n \"else: # dead code removal: don't follow all exits if the exitswitch #\",\n \"self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = []\",\n \"of debugging information --- self.frozen = False if policy is None: from rpython.annotator.policy\",\n \"self.added_blocks if newblocks is None: newblocks = self.annotated # all of them for\",\n \"enter an op; the latter can result in violations of the # more\",\n \"= constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try to pass\",\n \"subclass e.source = gather_error(self, graph, block, i) raise else: # dead code removal:\",\n \"new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as\",\n \"valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue corresponding to the given Variable\",\n \"KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value):\",\n \"to always raise an exception. We then # swallow the BlockedInference and that's\",\n \"pos = '?' if pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" %\",\n \"annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue corresponding to\",\n \"newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check\",\n \"def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated #\",\n \"the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming):\",\n \"= typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'):\",\n \"up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError\",\n \"v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif\",\n \"is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant():\",\n \"% annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None): if\",\n \"#___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic\",\n \"isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object else:\",\n \"if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\\\"Variable or Constant instance\",\n \"s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link,\",\n \"self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\" while True:\",\n \"it should try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator =\",\n \"class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None,\",\n \"text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v\",\n \"finished # make sure that the return variables of all graphs is annotated\",\n \"# wrong number of args # register the entry point self.addpendinggraph(flowgraph, inputcells) #\",\n \"else: return object else: raise TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got %r\\\"\",\n \"annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper\",\n \"operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind\",\n \"= (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells'\",\n \"return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if\",\n \"failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack\",\n \"the annotations based on operations ______ def consider_op(self, op): # let's be careful\",\n \"self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not\",\n \"block. # * self.annotated[block] == graph-containing-block: # analysis done (at least until we\",\n \"debugging --- self.blocked_graphs = {} # set of graphs that have blocked blocks\",\n \"renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const\",\n \"analysis done (at least until we find we must generalize the # input\",\n \"not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks\",\n \"def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is\",\n \"if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if\",\n \"_______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset\",\n \"in blocks _____________________ def processblock(self, graph, block): # Important: this is not called\",\n \"= AnnotatorPolicy() # make input arguments and set their type args_s = [self.typeannotation(t)\",\n \"and don't annotate the old # graph -- it's already low-level operations! for\",\n \"graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations\",\n \"if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX\",\n \"done (at least until we find we must generalize the # input variables).\",\n \"if translator is None: # interface for tests from rpython.translator.translator import TranslationContext translator\",\n \"results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool #\",\n \"from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set\",\n \"perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph, block): # Important:\",\n \"Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else:\",\n \"for v, s in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs:\",\n \"# this is the case where the last operation of the block will\",\n \"from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from\",\n \"= False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as\",\n \"get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy\",\n \"= (graph, e.opindex) except Exception as e: # hack for debug tools only\",\n \"= policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self,\",\n \"position_key): graph, block, i = position_key blk = \\\"\\\" if block: at =\",\n \"inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph,\",\n \"is not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs)\",\n \"op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some blocks\",\n \"link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link\",\n \"s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out =\",\n \"exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None:\",\n \"Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming =\",\n \"defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args,\",\n \"'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for\",\n \"None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type\",\n \"block in newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield\",\n \"self.policy = policy try: self.added_blocks = {} self.complete() # invoke annotation simplifications for\",\n \"and set their type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX\",\n \"assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block not in\",\n \"self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks\",\n \"self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def\",\n \"Variable or Constant.\\\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError return\",\n \"= op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e:\",\n \"in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs =\",\n \"e: if e.op is block.raising_op: # this is the case where the last\",\n \"low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg,\",\n \"already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert\",\n \"+= renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const =\",\n \"in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out = self.annotation(v_out) if v_out\",\n \"at = block.at() if at: blk = \\\" block\\\"+at opid=\\\"\\\" if i is\",\n \"are passed in, and don't annotate the old # graph -- it's already\",\n \"import model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection,\",\n \"self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert\",\n \"assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block\",\n \"Constant.\\\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError return s_arg def\",\n \"if self.added_blocks is not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs\",\n \"wrong number of args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively\",\n \"rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul)\",\n \"parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) #\",\n \"s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else:\",\n \"renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self,\",\n \"set of {blocked_block: (graph, index)} # --- the following information is recorded for\",\n \"AttributeError: self.break_at = None self.op = op self.opindex = opindex def __repr__(self): if\",\n \"with the flow object space. These are the operations for # which it\",\n \"make sure that the return variables of all graphs is annotated if self.added_blocks\",\n \"in newblocks: for op in block.operations: if op.opname in ('simple_call', 'call_args'): yield op\",\n \"UnionError is a subclass e.source = gather_error(self, graph, block, i) raise else: #\",\n \"SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference engine\",\n \"rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set their\",\n \"enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False)\",\n \"simplify, transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model import (\",\n \"the situation is currently blocked, and that it should try to progress elsewhere.\\\"\\\"\\\"\",\n \"renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out =\",\n \"raise # if the merged cells changed, we must redo the analysis if\",\n \"import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant,\",\n \"in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s\",\n \"block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def\",\n \"isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph,\",\n \"the initial bindings for the input args of a block. assert len(block.inputargs) ==\",\n \"callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase,\",\n \"self.annotated[block] = False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph,\",\n \"= graph assert block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block]\",\n \"is the case where the last operation of the block will # always\",\n \"block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {} for link in exits: constraints =\",\n \"statement so far. # (some functions actually never do, they always raise exceptions)\",\n \"an exception which is immediately caught by # an exception handler. We then\",\n \"operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This\",\n \"def gettype(self, variable): \\\"\\\"\\\"Return the known type of a control flow graph variable,\",\n \"graph that has already been rtyped. Safety-check the new # annotations that are\",\n \"called recursively. # self.flowin() can only issue calls to self.addpendingblock(). # The analysis\",\n \"# Merge the new 'cells' with each of the block's existing input #\",\n \"are partially annotated if op.result.annotation is None: break # ignore the unannotated part\",\n \"problematic (but will hopefully be solved # later by reflowing). Throw the BlockedInference\",\n \"v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't reach\",\n \"the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value\",\n \"intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case)\",\n \"{}) if whence is not None: if callable(whence): def callback(): whence(self, graph) else:\",\n \"[annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source\",\n \"i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self)\",\n \"warning, keep the name of the call operations in sync # with the\",\n \"if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if\",\n \"None self.op = op self.opindex = opindex def __repr__(self): if not self.break_at: break_at\",\n \"if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception = self.get_exception(op) for\",\n \"parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call #\",\n \"inputcells): # Create the initial bindings for the input args of a block.\",\n \"= False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True\",\n \"self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\" Return the\",\n \"BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result,\",\n \"this is the case where the last operation of the block will #\",\n \"* self.annotated[block] == False: # the input variables of the block have bindings\",\n \"newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph,\",\n \"graph, block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph\",\n \"raise TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self):\",\n \"is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not None), None) -> SomeBool(const=False) ...\",\n \"until no more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def\",\n \"True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in self.fixed_graphs\",\n \"if case is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break\",\n \"cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block)\",\n \"(should be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self,\",\n \"self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks =\",\n \"is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep\",\n \"self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___\",\n \"= True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get\",\n \"# * self.annotated[block] == False: # the input variables of the block have\",\n \"SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception\",\n \"checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args\",\n \"tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict\",\n \"# variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2)\",\n \"for all exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw\",\n \"graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def\",\n \"self self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated =\",\n \"information --- self.frozen = False if policy is None: from rpython.annotator.policy import AnnotatorPolicy\",\n \"transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs =\",\n \"an additional # small helper creates. if self.added_blocks is not None: self.added_blocks[block] =\",\n \"inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry point into block with\",\n \"{} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to\",\n \"if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert\",\n \"= len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of args # register\",\n \"if pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos = '?'\",\n \"isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input\",\n \"for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph,\",\n \"graph, block, inputcells): # Create the initial bindings for the input args of\",\n \"set of blocks already seen self.added_blocks = None # see processblock() below self.links_followed\",\n \"op.result op = new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if\",\n \"which are the new blocks that annotating an additional # small helper creates.\",\n \"not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning, keep the\",\n \"links that try to pass impossible values if s_out == s_ImpossibleValue: ignore_link =\",\n \"cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block]\",\n \"arg): \\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\" if isinstance(arg,\",\n \"elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes) if\",\n \"is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph, block):\",\n \"gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform\",\n \"source code to the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise #\",\n \"self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block)\",\n \"# all of them for block in newblocks: for op in block.operations: if\",\n \"# reflow from certain positions when this block is done for callback in\",\n \"the latter can result in violations of the # more general results invariant:\",\n \"= v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out\",\n \"None: break # ignore the unannotated part #___ simplification (should be moved elsewhere?)\",\n \"in exits: case = link.exitcase if case is None: self.follow_link(graph, link, {}) continue\",\n \"= False inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args,\",\n \"for link in block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call',\",\n \"from certain positions when this block is done for callback in self.notify[block]: if\",\n \"{block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to annotate again\",\n \"self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None: from\",\n \"an entry point into block with the given input cells.\\\"\\\"\\\" if graph in\",\n \"# get the (current) return value v = graph.getreturnvar() try: return self.binding(v) except\",\n \"block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell)\",\n \"annotating an additional # small helper creates. if self.added_blocks is not None: self.added_blocks[block]\",\n \"link.target, inputs_s) #___ creating the annotations based on operations ______ def consider_op(self, op):\",\n \"effects if translator is None: # interface for tests from rpython.translator.translator import TranslationContext\",\n \"inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy\",\n \"s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase,\",\n \"inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True\",\n \"is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy\",\n \"('simple_call', 'call_args', 'next'): # XXX warning, keep the name of the call operations\",\n \"of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is\",\n \"has already been rtyped. Safety-check the new # annotations that are passed in,\",\n \"__getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret\",\n \"v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and\",\n \"assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph,\",\n \"for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items():\",\n \"(types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value,\",\n \"finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is\",\n \"complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending\",\n \"s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\",\",\n \"{} # set of links that have ever been followed self.notify = {}\",\n \"= False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy()\",\n \"graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in self.annotated self.annotated[block] =\",\n \"self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy\",\n \"opid=\\\"\\\" if i is not None: opid = \\\" op=%d\\\" % i return\",\n \"assert False arg.annotation = s_value def warning(self, msg, pos=None): if pos is None:\",\n \"in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if\",\n \"must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): # Create\",\n \"= new_ops[0] self.consider_op(op) i += 1 except BlockedInference as e: if e.op is\",\n \"all of them for block in newblocks: for op in block.operations: if op.opname\",\n \"Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {} for link\",\n \"None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case))\",\n \"that the situation is currently blocked, and that it should try to progress\",\n \"raise an exception. We then # swallow the BlockedInference and that's it. #\",\n \"rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See\",\n \"case for annotating/rtyping in several phases: calling # a graph that has already\",\n \"type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value)\",\n \"None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks\",\n \"that `operation` may raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return\",\n \"that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue\",\n \"raise an exception which is immediately caught by # an exception handler. We\",\n \"= False # must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block,\",\n \"s_value): s_old = arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s\",\n \"s_arg = self.annotation(arg) if s_arg is None: raise KeyError return s_arg def typeannotation(self,\",\n \"rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import\",\n \"block not in self.annotated: # never seen the block. # * self.annotated[block] ==\",\n \"s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key):\",\n \"blocks until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break\",\n \"for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done\",\n \"KeyError: # the function didn't reach any return statement so far. # (some\",\n \"{} self.complete() # invoke annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy,\",\n \"is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen\",\n \"annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result def get_exception(self,\",\n \"None, long=True)) raise # if the merged cells changed, we must redo the\",\n \"graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag =\",\n \"return block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if\",\n \"annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False)\",\n \"True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___\",\n \"point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy()\",\n \"is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in the assert of\",\n \"knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link,\",\n \"the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged\",\n \"processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block] try:\",\n \"break # finished # make sure that the return variables of all graphs\",\n \"policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack\",\n \"from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error,\",\n \"self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break # finished # make sure that the return\",\n \"# has side effects if translator is None: # interface for tests from\",\n \"done in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text =\",\n \"args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self,\",\n \"this is not called recursively. # self.flowin() can only issue calls to self.addpendingblock().\",\n \"= self.annotation(arg) if s_arg is None: raise KeyError return s_arg def typeannotation(self, t):\",\n \"block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks until none\",\n \"def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry point into block with the\",\n \"the # input variables). #print '* processblock', block, cells self.annotated[block] = graph if\",\n \"def warning(self, msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key except\",\n \"s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue:\",\n \"a block can be in three states: # * block not in self.annotated:\",\n \"self.annotated[block] == False: # the input variables of the block have bindings but\",\n \"--- the following information is recorded for debugging --- self.blocked_graphs = {} #\",\n \"= s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation\",\n \"index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is\",\n \"i = position_key blk = \\\"\\\" if block: at = block.at() if at:\",\n \"the unannotated part #___ simplification (should be moved elsewhere?) _______ def simplify(self, block_subset=None,\",\n \"some blocks are partially annotated if op.result.annotation is None: break # ignore the\",\n \"yield op # some blocks are partially annotated if op.result.annotation is None: break\",\n \"but we # still have to consider all the operations in the block.\",\n \"constraints) if block in self.notify: # reflow from certain positions when this block\",\n \"def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block]\",\n \"s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc\",\n \"self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value =\",\n \"self.translator.graphs else: graphs = {} for block in block_subset: graph = self.annotated.get(block) if\",\n \"the exceptional # branches. exits = [link for link in block.exits if link.exitcase\",\n \"arg): \\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\" s_arg =\",\n \"typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata\",\n \"self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in self.annotated.items() if done\",\n \"type newcell = typeof(renamed_is_type_of) if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if\",\n \"block.canraise: op = block.raising_op s_exception = self.get_exception(op) for link in exits: case =\",\n \"a position else: callback() def follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType,\",\n \"s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating\",\n \"None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks =\",\n \"False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e:\",\n \"creates. if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block):\",\n \"follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType,\",\n \"# map {block: graph-containing-it} self.annotated = {} # set of blocks already seen\",\n \"operation): \\\"\\\"\\\" Return the annotation for all exceptions that `operation` may raise. \\\"\\\"\\\"\",\n \"# to enter an op; the latter can result in violations of the\",\n \"follow all exits if the exitswitch # is known exits = block.exits if\",\n \"False: # the input variables of the block have bindings but we #\",\n \"in self.fixed_graphs: # special case for annotating/rtyping in several phases: calling # a\",\n \"v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] =\",\n \"graphs is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for block\",\n \"positions when this block is done for callback in self.notify[block]: if isinstance(callback, tuple):\",\n \"== s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if s_matching_exc !=\",\n \"block: at = block.at() if at: blk = \\\" block\\\"+at opid=\\\"\\\" if i\",\n \"def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence\",\n \"= translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {} #\",\n \"constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in constraints.items(): new_vs =\",\n \"values if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out)\",\n \"self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations\",\n \"= v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link]\",\n \"self.notify.setdefault(graph.returnblock, {}) if whence is not None: if callable(whence): def callback(): whence(self, graph)\",\n \"= ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy)\",\n \"input args of a block. assert len(block.inputargs) == len(inputcells) for a, cell in\",\n \"and that it should try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex):\",\n \"s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata\",\n \"for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry\",\n \"= op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue:\",\n \"new_ops if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i\",\n \"not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" % (s_value, s_old))\",\n \"e: # hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block',\",\n \"False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks\",\n \"that's it. # About 'next': see test_annotate_iter_empty_container(). return else: # other cases are\",\n \"True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph,\",\n \"to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator = annotator try: self.break_at\",\n \"import simplify, transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model import\",\n \"import rpython.rtyper.extfuncregistry # has side effects if translator is None: # interface for\",\n \"annotated if op.result.annotation is None: break # ignore the unannotated part #___ simplification\",\n \"if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] =\",\n \"of args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until\",\n \"\\\" block\\\"+at opid=\\\"\\\" if i is not None: opid = \\\" op=%d\\\" %\",\n \"should try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator, op, opindex): self.annotator = annotator\",\n \"return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference engine that the\",\n \"the block. # * self.annotated[block] == graph-containing-block: # analysis done (at least until\",\n \"# {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs not to annotate\",\n \"in, and don't annotate the old # graph -- it's already low-level operations!\",\n \"zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const\",\n \"return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells)\",\n \"block\\\"+at opid=\\\"\\\" if i is not None: opid = \\\" op=%d\\\" % i\",\n \"the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) #\",\n \"graphs = self.translator.graphs else: graphs = {} for block in block_subset: graph =\",\n \"new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1 except\",\n \"# bind resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\" Return the annotation for\",\n \"= annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op =\",\n \"only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks'\",\n \"latter can result in violations of the # more general results invariant: e.g.\",\n \"self.annotated # all of them for block in newblocks: for op in block.operations:\",\n \"and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = [] renaming = defaultdict(list) for\",\n \"is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for block in\",\n \"if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise\",\n \"import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import\",\n \"AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells\",\n \"def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________\",\n \"= {} # set of links that have ever been followed self.notify =\",\n \"proceed until no more pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar())\",\n \"cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen\",\n \"-- in the assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue):\",\n \"assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out =\",\n \"= self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy):\",\n \"got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks\",\n \"let's be careful about avoiding propagated SomeImpossibleValues # to enter an op; the\",\n \"# dead code removal: don't follow all exits if the exitswitch # is\",\n \"for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position\",\n \"(pos, msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if\",\n \"from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython.\",\n \"new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const\",\n \"{} for value, constraints in s_out.knowntypedata.items(): renamed_knowntypedata[value] = {} for v, s in\",\n \"s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for\",\n \"# set of graphs not to annotate again self.blocked_blocks = {} # set\",\n \"information is recorded for debugging --- self.blocked_graphs = {} # set of graphs\",\n \"if the exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch\",\n \"self.notify: # reflow from certain positions when this block is done for callback\",\n \"is a subclass e.source = gather_error(self, graph, block, i) raise else: # dead\",\n \"policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function,\",\n \"<filename>rpython/annotator/annrpython.py from __future__ import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print\",\n \"zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not\",\n \"self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return\",\n \"None: graphs = self.translator.graphs else: graphs = {} for block in block_subset: graph\",\n \"moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset, extra_passes=extra_passes)\",\n \"# later by reflowing). Throw the BlockedInference up to # processblock(). e.opindex =\",\n \"# Important: this is not called recursively. # self.flowin() can only issue calls\",\n \"% (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level\",\n \"= annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out\",\n \"is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is\",\n \"is not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result\",\n \"for block, done in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks)\",\n \"return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference\",\n \"in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell = typeof(renamed_is_type_of) if\",\n \"annotations in blocks _____________________ def processblock(self, graph, block): # Important: this is not\",\n \"self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def\",\n \"except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError is a\",\n \"#all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in\",\n \"for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs):\",\n \"self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {}\",\n \"the flow object space. These are the operations for # which it is\",\n \"= self.translator.graphs else: graphs = {} for block in block_subset: graph = self.annotated.get(block)\",\n \"translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is None:\",\n \"for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator\",\n \"self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells)\",\n \"self.notify[graph.returnblock] is a dictionary of call # points to this func which triggers\",\n \"as e: # Add source code to the UnionError e.source = '\\\\n'.join(source_lines(graph, block,\",\n \"= position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is None:\",\n \"be moved elsewhere?) _______ def simplify(self, block_subset=None, extra_passes=None): # Generic simplifications transform.transform_graph(self, block_subset=block_subset,\",\n \"opid def flowin(self, graph, block): try: i = 0 while i < len(block.operations):\",\n \"v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out =\",\n \"v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming)\",\n \"raise. \\\"\\\"\\\" can_only_throw = operation.get_can_only_throw(self) if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return\",\n \"of the # more general results invariant: e.g. if SomeImpossibleValue enters is_ #\",\n \"if key not in attrs: assert type(value) is dict, ( \\\"%r is not\",\n \"if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self,\",\n \"knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow from certain\",\n \"= {} return ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types,\",\n \"s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase == s_exitswitch.const] if\",\n \"from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator\",\n \"new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if not\",\n \"blocks # --- end of debugging information --- self.frozen = False if policy\",\n \"# callback is a position else: callback() def follow_link(self, graph, link, constraints): assert\",\n \"be careful about avoiding propagated SomeImpossibleValues # to enter an op; the latter\",\n \"import AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set their type\",\n \"XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph,\",\n \"interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block,\",\n \"in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self):\",\n \"if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph,\",\n \"def processblock(self, graph, block): # Important: this is not called recursively. # self.flowin()\",\n \"callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else:\",\n \"self.binding(v) except KeyError: # the function didn't reach any return statement so far.\",\n \"[self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in\",\n \"defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out in link.args: s_out\",\n \"as e: # note that UnionError is a subclass e.source = gather_error(self, graph,\",\n \"renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based\",\n \"ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value):\",\n \"in several phases: calling # a graph that has already been rtyped. Safety-check\",\n \"Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify\",\n \"exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block)\",\n \"# an exception handler. We then only follow the exceptional # branches. exits\",\n \"= flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc =\",\n \"cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self):\",\n \"position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks\",\n \"not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i += 1\",\n \"inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number\",\n \"s_newarg) == s_oldarg else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph,\",\n \"# --- end of debugging information --- self.frozen = False if policy is\",\n \"\\\"%r is not dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {}\",\n \"didn't reach any return statement so far. # (some functions actually never do,\",\n \"except BlockedInference as e: if e.op is block.raising_op: # this is the case\",\n \"# which it is fine to always raise an exception. We then #\",\n \"that UnionError is a subclass e.source = gather_error(self, graph, block, i) raise else:\",\n \"block is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback\",\n \"s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link]\",\n \"annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph\",\n \"medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph,\",\n \"value v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't\",\n \"annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block not in self.annotated:\",\n \"in self.annotated: # never seen the block. # * self.annotated[block] == False: #\",\n \"{} return ret #___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True,\",\n \"self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph\",\n \"redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out,\",\n \"None: # interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator\",\n \"s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out)\",\n \"None # see processblock() below self.links_followed = {} # set of links that\",\n \"self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {} # set of\",\n \"def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks =\",\n \"the SomeValue corresponding to the given Variable or Constant.\\\" s_arg = self.annotation(arg) if\",\n \"= dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs #all of\",\n \"inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry point\",\n \"return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is\",\n \"op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is\",\n \"that are passed in, and don't annotate the old # graph -- it's\",\n \"= self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\"\",\n \"s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {}\",\n \"rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator\",\n \"issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type,\",\n \"== v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant():\",\n \"that annotating an additional # small helper creates. if self.added_blocks is not None:\",\n \"else: graphs = {} for block in block_subset: graph = self.annotated.get(block) if graph:\",\n \"BlockedInference as e: if e.op is block.raising_op: # this is the case where\",\n \"(format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import simplify,\",\n \"attrs: assert type(value) is dict, ( \\\"%r is not dict. please update %s.__getstate__\\\"\",\n \"self.flowin() can only issue calls to self.addpendingblock(). # The analysis of a block\",\n \"i is not None: opid = \\\" op=%d\\\" % i return repr(graph) +\",\n \"operations for # which it is fine to always raise an exception. We\",\n \"assert of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op,\",\n \"inputs_s) #___ creating the annotations based on operations ______ def consider_op(self, op): #\",\n \"= self.added_blocks if newblocks is None: newblocks = self.annotated # all of them\",\n \"input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v =\",\n \"\\\"\\\"\\\"Recursively build annotations about the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\"\",\n \"opid = \\\" op=%d\\\" % i return repr(graph) + blk + opid def\",\n \"if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if\",\n \"we must redo the analysis if unions != oldcells: self.bindinputargs(graph, block, unions) def\",\n \"None: self.added_blocks[block] = True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph\",\n \"situation is currently blocked, and that it should try to progress elsewhere.\\\"\\\"\\\" def\",\n \"generalize the # input variables). #print '* processblock', block, cells self.annotated[block] = graph\",\n \"to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation\",\n \"about avoiding propagated SomeImpossibleValues # to enter an op; the latter can result\",\n \"= saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells)\",\n \"policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self):\",\n \"TypeError('Variable or Constant expected, got %r' % (arg,)) def binding(self, arg): \\\"Gives the\",\n \"= self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else: assert not self.frozen if block\",\n \"for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else:\",\n \"self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack for debug tools\",\n \"== s_oldarg else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block,\",\n \"code to the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if\",\n \"side effects if translator is None: # interface for tests from rpython.translator.translator import\",\n \"%r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___\",\n \"if s_arg is None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t,\",\n \"# hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block)\",\n \"saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) ==\",\n \"in self.notify: # reflow from certain positions when this block is done for\",\n \"= self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete() # invoke\",\n \"_______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index =\",\n \"= new_ops if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op)\",\n \"# must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): #\",\n \"args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try:\",\n \"# must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells): #\",\n \"self.annotated[block] == graph-containing-block: # analysis done (at least until we find we must\",\n \"ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] =\",\n \"v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value]) if\",\n \"Constant expected, got %r' % (arg,)) def binding(self, arg): \\\"Gives the SomeValue corresponding\",\n \"repr(graph) + blk + opid def flowin(self, graph, block): try: i = 0\",\n \"= self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now)\",\n \"if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out,\",\n \"__init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is\",\n \"don't follow all exits if the exitswitch # is known exits = block.exits\",\n \"not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value,\",\n \"None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self,\",\n \"instance expected, \\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of\",\n \"in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add source code to the UnionError\",\n \"or Constant instance expected, \\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a\",\n \"= graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the\",\n \"are problematic (but will hopefully be solved # later by reflowing). Throw the\",\n \"(variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface\",\n \"by # an exception handler. We then only follow the exceptional # branches.\",\n \"(current) return value v = graph.getreturnvar() try: return self.binding(v) except KeyError: # the\",\n \"until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not self.pendingblocks: break #\",\n \"'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if\",\n \"based on operations ______ def consider_op(self, op): # let's be careful about avoiding\",\n \"{}) else: knowntypedata = {} for link in exits: constraints = knowntypedata.get(link.exitcase, {})\",\n \"done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit()\",\n \"block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence\",\n \"see processblock() below self.links_followed = {} # set of links that have ever\",\n \"= self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for\",\n \"= 0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block, i)):\",\n \"not None: block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result op\",\n \"def get_exception(self, operation): \\\"\\\"\\\" Return the annotation for all exceptions that `operation` may\",\n \"= True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations ______\",\n \"s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value, constraints\",\n \"# self.flowin() can only issue calls to self.addpendingblock(). # The analysis of a\",\n \"e.opindex) except Exception as e: # hack for debug tools only if not\",\n \"'* processblock', block, cells self.annotated[block] = graph if block in self.blocked_blocks: del self.blocked_blocks[block]\",\n \"call # points to this func which triggers a reflow whenever the #\",\n \"\\\"\\\" if block: at = block.at() if at: blk = \\\" block\\\"+at opid=\\\"\\\"\",\n \"block) def complete(self): \\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks()\",\n \"# is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if\",\n \"block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs\",\n \"if s_exception == s_ImpossibleValue: break s_case = SomeInstance(self.bookkeeper.getuniqueclassdef(case)) s_matching_exc = intersection(s_exception, s_case) if\",\n \"= renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool)\",\n \"typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations\",\n \"callback is a position else: callback() def follow_link(self, graph, link, constraints): assert not\",\n \"#___ convenience high-level interface __________________ def build_types(self, function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build\",\n \"in exits if link.exitcase == s_exitswitch.const] if block.canraise: op = block.raising_op s_exception =\",\n \"can be in three states: # * block not in self.annotated: # never\",\n \"\\\"\\\"\\\" Return the annotation for all exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw\",\n \"if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable:\",\n \"# set of links that have ever been followed self.notify = {} #\",\n \"Merge the new 'cells' with each of the block's existing input # variables.\",\n \"= intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception,\",\n \"this block is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) #\",\n \"None: opid = \\\" op=%d\\\" % i return repr(graph) + blk + opid\",\n \"== nbarg # wrong number of args # register the entry point self.addpendinggraph(flowgraph,\",\n \"= {} # set of graphs not to annotate again self.blocked_blocks = {}\",\n \"i) raise else: # dead code removal: don't follow all exits if the\",\n \"= block.raising_op s_exception = self.get_exception(op) for link in exits: case = link.exitcase if\",\n \"= pair(s_out, s_constraint).improve() # ignore links that try to pass impossible values if\",\n \"is immediately caught by # an exception handler. We then only follow the\",\n \"except BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] =\",\n \"log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self, msg, pos=None):\",\n \"[] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype is type newcell\",\n \"blk = \\\" block\\\"+at opid=\\\"\\\" if i is not None: opid = \\\"\",\n \"new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True):\",\n \"block): # Important: this is not called recursively. # self.flowin() can only issue\",\n \"self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of graphs\",\n \"self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in newgraphs else: newgraphs = self.translator.graphs\",\n \"pair(s_out, s_constraint).improve() # ignore links that try to pass impossible values if s_out\",\n \"= link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value\",\n \"s_exception = self.get_exception(op) for link in exits: case = link.exitcase if case is\",\n \"False arg.annotation = s_value def warning(self, msg, pos=None): if pos is None: try:\",\n \"= link.exitcase if case is None: self.follow_link(graph, link, {}) continue if s_exception ==\",\n \"!= s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable):\",\n \"SomeImpossibleValues # to enter an op; the latter can result in violations of\",\n \"get_exception(self, operation): \\\"\\\"\\\" Return the annotation for all exceptions that `operation` may raise.\",\n \"self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface __________________ def build_types(self,\",\n \"self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known type of a control\",\n \"not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem()\",\n \"= s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block,\",\n \"'added_blocks' is used by rpython.annlowlevel to # detect which are the new blocks\",\n \"addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry point into block with the given\",\n \"except AttributeError: self.break_at = None self.op = op self.opindex = opindex def __repr__(self):\",\n \"warning(self, msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key except AttributeError:\",\n \"i = 0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph, block,\",\n \"v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out\",\n \"dict 'added_blocks' is used by rpython.annlowlevel to # detect which are the new\",\n \"tag) # self.notify[graph.returnblock] is a dictionary of call # points to this func\",\n \"Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import model as\",\n \"--- end of debugging information --- self.frozen = False if policy is None:\",\n \"= variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\\\"Variable or\",\n \"isinstance(block.exitswitch, Variable): s_exitswitch = self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in\",\n \"s_matching_exc = intersection(s_exception, s_case) if s_matching_exc != s_ImpossibleValue: self.follow_raise_link(graph, link, s_matching_exc) s_exception =\",\n \"position_key blk = \\\"\\\" if block: at = block.at() if at: blk =\",\n \"parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is\",\n \"block can be in three states: # * block not in self.annotated: #\",\n \"AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s,\",\n \"self.blocked_blocks = {} # set of {blocked_block: (graph, index)} # --- the following\",\n \"import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from\",\n \"bindings for the input args of a block. assert len(block.inputargs) == len(inputcells) for\",\n \"prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy import\",\n \"the given Variable or Constant.\\\" s_arg = self.annotation(arg) if s_arg is None: raise\",\n \"not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block,\",\n \"[self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph,\",\n \"= op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if not new_ops:\",\n \"all exits if the exitswitch # is known exits = block.exits if isinstance(block.exitswitch,\",\n \"(s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation = s_value def warning(self,\",\n \"function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None)\",\n \"exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: #\",\n \"self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def annotate_helper(self, function, args_s,\",\n \"elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r'\",\n \"can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals\",\n \"have to consider all the operations in the block. # * self.annotated[block] ==\",\n \"self.policy = policy self.bookkeeper.enter(None) try: return desc.get_call_parameters(args_s) finally: self.bookkeeper.leave() self.policy = prevpolicy def\",\n \"s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\\\"Variable\",\n \"False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph, block, inputcells):\",\n \"self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph\",\n \"'cells' with each of the block's existing input # variables. oldcells = [self.binding(a)\",\n \"in ('simple_call', 'call_args', 'next'): # XXX warning, keep the name of the call\",\n \"def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy =\",\n \"complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy =\",\n \"arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self)\",\n \"\\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return\",\n \"self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type =\",\n \"bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is None: # interface\",\n \"(some functions actually never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self,\",\n \"phases: calling # a graph that has already been rtyped. Safety-check the new\",\n \"self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self,\",\n \"v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s =\",\n \"if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link,\",\n \"block, inputcells): # Create the initial bindings for the input args of a\",\n \"None) -> SomeBool(const=False) ... # boom -- in the assert of setbinding() for\",\n \"partially annotated if op.result.annotation is None: break # ignore the unannotated part #___\",\n \"try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op = op self.opindex\",\n \"for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block,\",\n \"# set of graphs that have blocked blocks # --- end of debugging\",\n \"raise BlockedInference(self, op, -1) # the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert\",\n \"to pass impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out =\",\n \"flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an entry point into block\",\n \"'__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used by rpython.annlowlevel\",\n \"( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph\",\n \"# more general results invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None)\",\n \"tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator =\",\n \"inputcells) # recursively proceed until no more pending block is left if complete_now:\",\n \"intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\")\",\n \"number of args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed\",\n \"if not s_value.contains(s_old): log.WARNING(\\\"%s does not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" %\",\n \"temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack for debug\",\n \"while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self): \\\"\\\"\\\"Process pending blocks\",\n \"= self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint()\",\n \"ret.items(): if key not in attrs: assert type(value) is dict, ( \\\"%r is\",\n \"isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make\",\n \"getuserclassdefinitions(self): \\\"\\\"\\\"Return a list of ClassDefs.\\\"\\\"\\\" return self.bookkeeper.classdefs #___ medium-level interface ____________________________ def\",\n \"block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block,\",\n \"= s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata = {} for value,\",\n \"s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out\",\n \"= True def reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in\",\n \"and that's it. # About 'next': see test_annotate_iter_empty_container(). return else: # other cases\",\n \"always raise an exception which is immediately caught by # an exception handler.\",\n \"pending block is left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return\",\n \"from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper\",\n \"(arg,)) def binding(self, arg): \\\"Gives the SomeValue corresponding to the given Variable or\",\n \"is a dictionary of call # points to this func which triggers a\",\n \"annotate the old # graph -- it's already low-level operations! for a, s_newarg\",\n \"isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out\",\n \"assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell) # bind resultcell to op.result\",\n \"block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for graph in graphs:\",\n \"= \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy()\",\n \"transform from rpython.annotator import model as annmodel, signature from rpython.annotator.model import ( typeof,\",\n \"if unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out,\",\n \"= {} # set of {blocked_block: (graph, index)} # --- the following information\",\n \"i return repr(graph) + blk + opid def flowin(self, graph, block): try: i\",\n \"if can_only_throw is None: return SomeInstance(self.bookkeeper.getuniqueclassdef(Exception)) else: return self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception\",\n \"= self.__dict__.copy() for key, value in ret.items(): if key not in attrs: assert\",\n \"isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self, graph,\",\n \"in violations of the # more general results invariant: e.g. if SomeImpossibleValue enters\",\n \"if s_out.is_constant(): newcell.const = s_out.const s_out = newcell if hasattr(s_out, 'knowntypedata'): renamed_knowntypedata =\",\n \"self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] =\",\n \"constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify: # reflow\",\n \"signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not\",\n \"except KeyError: # the function didn't reach any return statement so far. #\",\n \"None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if\",\n \"is recorded for debugging --- self.blocked_graphs = {} # set of graphs that\",\n \"link in block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args',\",\n \"return type(variable.value) elif isinstance(variable, Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else:\",\n \"format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar()\",\n \"[block for block, done in self.annotated.items() if done is False] assert len(blocked_blocks) ==\",\n \"return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known type of a control flow\",\n \"def complete(self): \\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self)\",\n \"variables of all graphs is annotated if self.added_blocks is not None: newgraphs =\",\n \"for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type: s_out = typeof(renaming[v_last_exc_value])\",\n \"not self.break_at: break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s\",\n \"def callback(): whence(self, graph) else: callback = whence callpositions[callback] = True # generalize\",\n \"(graph, e.opindex) except Exception as e: # hack for debug tools only if\",\n \"in attrs: assert type(value) is dict, ( \\\"%r is not dict. please update\",\n \"resultcell to op.result def get_exception(self, operation): \\\"\\\"\\\" Return the annotation for all exceptions\",\n \"self.get_exception(op) for link in exits: case = link.exitcase if case is None: self.follow_link(graph,\",\n \"op self.opindex = opindex def __repr__(self): if not self.break_at: break_at = \\\"?\\\" else:\",\n \"to enter an op; the latter can result in violations of the #\",\n \"defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable): s_variable =\",\n \"block not in self.annotated: self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not\",\n \"__future__ import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger\",\n \"exception which is immediately caught by # an exception handler. We then only\",\n \"does not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False\",\n \"left if complete_now: self.complete() return self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known type\",\n \"'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert s_out.knowntype\",\n \"graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks\",\n \"the BlockedInference up to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return\",\n \"--- self.frozen = False if policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy\",\n \"Add source code to the UnionError e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise\",\n \"has side effects if translator is None: # interface for tests from rpython.translator.translator\",\n \"annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None: resultcell\",\n \"graph.startblock, inputcells) # get the (current) return value v = graph.getreturnvar() try: return\",\n \"t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s =\",\n \"True self.addpendingblock(graph, link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value\",\n \"\\\"\\\"\\\"This exception signals the type inference engine that the situation is currently blocked,\",\n \"that have blocked blocks # --- end of debugging information --- self.frozen =\",\n \"if block: at = block.at() if at: blk = \\\" block\\\"+at opid=\\\"\\\" if\",\n \"inference engine that the situation is currently blocked, and that it should try\",\n \"actually never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph,\",\n \"graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if\",\n \"BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph,\",\n \"{block: graph-containing-it} self.annotated = {} # set of blocks already seen self.added_blocks =\",\n \"# note that UnionError is a subclass e.source = gather_error(self, graph, block, i)\",\n \"= opindex def __repr__(self): if not self.break_at: break_at = \\\"?\\\" else: break_at =\",\n \"all the operations in the block. # * self.annotated[block] == graph-containing-block: # analysis\",\n \"(graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with\",\n \"= (graph, None) def bindinputargs(self, graph, block, inputcells): # Create the initial bindings\",\n \"import absolute_import import types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from\",\n \"True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on operations ______ def\",\n \"their type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul\",\n \"if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v]\",\n \"flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong\",\n \"from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper\",\n \"self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() #\",\n \"# other cases are problematic (but will hopefully be solved # later by\",\n \"self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks)\",\n \"the new blocks that annotating an additional # small helper creates. if self.added_blocks\",\n \"v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that\",\n \"self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg\",\n \"graph if block in self.blocked_blocks: del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as\",\n \"in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint = constraints[v_out] s_out\",\n \"in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback) # callback is a position else: callback()\",\n \"that try to pass impossible values if s_out == s_ImpossibleValue: ignore_link = True\",\n \"if not self.pendingblocks: break # finished # make sure that the return variables\",\n \"v_out in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links\",\n \"%r' % (arg,)) def binding(self, arg): \\\"Gives the SomeValue corresponding to the given\",\n \"msg, pos=None): if pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos\",\n \"issue calls to self.addpendingblock(). # The analysis of a block can be in\",\n \"% i return repr(graph) + blk + opid def flowin(self, graph, block): try:\",\n \"type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul =\",\n \"not called recursively. # self.flowin() can only issue calls to self.addpendingblock(). # The\",\n \"that have ever been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs =\",\n \"assert len(inputcells) == nbarg # wrong number of args # register the entry\",\n \"link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'): # XXX warning,\",\n \"inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input)\",\n \"is not called recursively. # self.flowin() can only issue calls to self.addpendingblock(). #\",\n \"not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] = graph assert block in\",\n \"self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) def\",\n \"return s_variable.knowntype else: return object else: raise TypeError(\\\"Variable or Constant instance expected, \\\"\",\n \"hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used by\",\n \"= \\\"\\\" if block: at = block.at() if at: blk = \\\" block\\\"+at\",\n \"if block in self.notify: # reflow from certain positions when this block is\",\n \"bindings but we # still have to consider all the operations in the\",\n \"generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return\",\n \"in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing annotations in\",\n \"______ def consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues #\",\n \"self.get_call_parameters(function, args_s, policy) if main_entry_point: self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def\",\n \"contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation =\",\n \"of graphs not to annotate again self.blocked_blocks = {} # set of {blocked_block:\",\n \"# About 'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic (but\",\n \"annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index\",\n \"annotation simplifications for the new blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def\",\n \"in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function,\",\n \"AnnotatorPolicy() # make input arguments and set their type args_s = [self.typeannotation(t) for\",\n \"can only issue calls to self.addpendingblock(). # The analysis of a block can\",\n \"annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError is a subclass\",\n \"== s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return\",\n \"% (arg,)) def binding(self, arg): \\\"Gives the SomeValue corresponding to the given Variable\",\n \"self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge the new\",\n \"constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try\",\n \"graph def complete_pending_blocks(self): while self.pendingblocks: block, graph = self.pendingblocks.popitem() self.processblock(graph, block) def complete(self):\",\n \"got_blocked_blocks = False in self.annotated.values() if got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] =\",\n \"all graphs is annotated if self.added_blocks is not None: newgraphs = [self.annotated[block] for\",\n \"not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used\",\n \"not self.pendingblocks: break # finished # make sure that the return variables of\",\n \"= [self.binding(a) for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2\",\n \"for v_out in link.args: s_out = self.annotation(v_out) if v_out in constraints: s_constraint =\",\n \"self.consider_op(op) i += 1 except BlockedInference as e: if e.op is block.raising_op: #\",\n \"for t in input_arg_types] # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s\",\n \"gettype(self, variable): \\\"\\\"\\\"Return the known type of a control flow graph variable, defaulting\",\n \"any return statement so far. # (some functions actually never do, they always\",\n \"self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False # failed,\",\n \"function, input_arg_types, complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific entry point.\\\"\\\"\\\" assert\",\n \"blk + opid def flowin(self, graph, block): try: i = 0 while i\",\n \"# is_(SomeInstance(not None), None) -> SomeBool(const=False) ... # boom -- in the assert\",\n \"Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import model as annmodel,\",\n \"newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated # all of\",\n \"not None: opid = \\\" op=%d\\\" % i return repr(graph) + blk +\",\n \"extra_passes=extra_passes) if block_subset is None: graphs = self.translator.graphs else: graphs = {} for\",\n \"s in constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] =\",\n \"if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0] self.consider_op(op) i +=\",\n \"ret = self.__dict__.copy() for key, value in ret.items(): if key not in attrs:\",\n \"if newblocks is None: newblocks = self.annotated # all of them for block\",\n \"Variable): s_variable = variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise\",\n \"RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry #\",\n \"policy = AnnotatorPolicy() # make input arguments and set their type args_s =\",\n \"zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out, v_input in zip(link.args, link.target.inputargs): if v_out == v_last_exc_type:\",\n \"import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description\",\n \"#___ flowing annotations in blocks _____________________ def processblock(self, graph, block): # Important: this\",\n \"except annmodel.AnnotatorError as e: # note that UnionError is a subclass e.source =\",\n \"# a graph that has already been rtyped. Safety-check the new # annotations\",\n \"in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in self.annotated.items()\",\n \"self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block, done in self.annotated.items() if\",\n \"to # processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as\",\n \"import Variable, Constant, checkgraph from rpython.translator import simplify, transform from rpython.annotator import model\",\n \"each of the block's existing input # variables. oldcells = [self.binding(a) for a\",\n \"are the new blocks that annotating an additional # small helper creates. if\",\n \"of them for block in newblocks: for op in block.operations: if op.opname in\",\n \"follow_link(self, graph, link, constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link\",\n \"Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const = v_last_exc_type.annotation.const inputs_s.append(s_out) else: s_out =\",\n \"None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul =\",\n \"import TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks =\",\n \"function, args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy =\",\n \"assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type,\",\n \"never seen the block. # * self.annotated[block] == False: # the input variables\",\n \"for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None: perform_normalizations(self) #___ flowing\",\n \"policy) self.build_graph_types(graph, inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy,\",\n \"of a control flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return\",\n \"raise # The dict 'added_blocks' is used by rpython.annlowlevel to # detect which\",\n \"is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1)\",\n \"is not dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {} return\",\n \"graph, block): try: i = 0 while i < len(block.operations): op = block.operations[i]\",\n \"= parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary of call\",\n \"= self self.translator = translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated\",\n \"processblock(self, graph, block): # Important: this is not called recursively. # self.flowin() can\",\n \"rtyped. Safety-check the new # annotations that are passed in, and don't annotate\",\n \"____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells):\",\n \"careful about avoiding propagated SomeImpossibleValues # to enter an op; the latter can\",\n \"old # graph -- it's already low-level operations! for a, s_newarg in zip(block.inputargs,\",\n \"if isinstance(v_last_exc_value, Variable): self.setbinding(v_last_exc_value, s_last_exc_value) if isinstance(v_last_exc_type, Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = []\",\n \"ignore the unannotated part #___ simplification (should be moved elsewhere?) _______ def simplify(self,\",\n \"link.exitcase if case is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue:\",\n \"index)} # --- the following information is recorded for debugging --- self.blocked_graphs =\",\n \"unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: #\",\n \"avoiding propagated SomeImpossibleValues # to enter an op; the latter can result in\",\n \"policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value in ret.items(): if key not\",\n \"end of debugging information --- self.frozen = False if policy is None: from\",\n \"binding(self, arg): \\\"Gives the SomeValue corresponding to the given Variable or Constant.\\\" s_arg\",\n \"= AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self)\",\n \"\\\"\\\"\\\"Block annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None):\",\n \"assert type(value) is dict, ( \\\"%r is not dict. please update %s.__getstate__\\\" %\",\n \"of the block have bindings but we # still have to consider all\",\n \"operations in the block. # * self.annotated[block] == graph-containing-block: # analysis done (at\",\n \"as e: # hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e,\",\n \"cells changed, we must redo the analysis if unions != oldcells: self.bindinputargs(graph, block,\",\n \"link, s_matching_exc) s_exception = difference(s_exception, s_case) else: if isinstance(block.exitswitch, Variable): knowntypedata = getattr(\",\n \"input variables). #print '* processblock', block, cells self.annotated[block] = graph if block in\",\n \"assert block in self.annotated self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph,\",\n \"v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException))\",\n \"s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i = position_key blk =\",\n \"graph -- it's already low-level operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg\",\n \"again self.blocked_blocks = {} # set of {blocked_block: (graph, index)} # --- the\",\n \"if graph: graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset\",\n \"# * block not in self.annotated: # never seen the block. # *\",\n \"block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some blocks are partially\",\n \"block's existing input # variables. oldcells = [self.binding(a) for a in block.inputargs] try:\",\n \"self.annotated[block] = False # must re-flow self.blocked_blocks[block] = (graph, None) def bindinputargs(self, graph,\",\n \"import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph from rpython.translator import\",\n \"annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy\",\n \"blocked_blocks = [block for block, done in self.annotated.items() if done is False] assert\",\n \"is currently blocked, and that it should try to progress elsewhere.\\\"\\\"\\\" def __init__(self,\",\n \"Important: this is not called recursively. # self.flowin() can only issue calls to\",\n \"if s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase == s_exitswitch.const]\",\n \"def mergeinputargs(self, graph, block, inputcells): # Merge the new 'cells' with each of\",\n \"# analysis done (at least until we find we must generalize the #\",\n \"if callable(whence): def callback(): whence(self, graph) else: callback = whence callpositions[callback] = True\",\n \"invariant: e.g. if SomeImpossibleValue enters is_ # is_(SomeImpossibleValue, None) -> SomeBool # is_(SomeInstance(not\",\n \"is fine to always raise an exception. We then # swallow the BlockedInference\",\n \"# failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: #\",\n \"be solved # later by reflowing). Throw the BlockedInference up to # processblock().\",\n \"self.annotator = annotator try: self.break_at = annotator.bookkeeper.position_key except AttributeError: self.break_at = None self.op\",\n \"graph, block, cells): \\\"\\\"\\\"Register an entry point into block with the given input\",\n \"the # return block of this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock,\",\n \"s_variable: return s_variable.knowntype else: return object else: raise TypeError(\\\"Variable or Constant instance expected,\",\n \"msg)) #___ interface for annotator.bookkeeper _______ def recursivecall(self, graph, whence, inputcells): if isinstance(whence,\",\n \"self.addpendingblock(). # The analysis of a block can be in three states: #\",\n \"# let's be careful about avoiding propagated SomeImpossibleValues # to enter an op;\",\n \"# finished # make sure that the return variables of all graphs is\",\n \"it is fine to always raise an exception. We then # swallow the\",\n \"def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg\",\n \"is used by rpython.annlowlevel to # detect which are the new blocks that\",\n \"attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret =\",\n \"isinstance(block.exitswitch, Variable): knowntypedata = getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {} for\",\n \"this graph has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not\",\n \"= self.get_exception(op) for link in exits: case = link.exitcase if case is None:\",\n \"self.annotated: # never seen the block. # * self.annotated[block] == False: # the\",\n \"* block not in self.annotated: # never seen the block. # * self.annotated[block]\",\n \"given Variable or Constant.\\\" s_arg = self.annotation(arg) if s_arg is None: raise KeyError\",\n \"self.translator.entry_point_graph = flowgraph return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc\",\n \"whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a dictionary\",\n \"they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key): graph, block, index =\",\n \"set their type args_s = [self.typeannotation(t) for t in input_arg_types] # XXX hack\",\n \"typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs):\",\n \"position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks\",\n \"'next': see test_annotate_iter_empty_container(). return else: # other cases are problematic (but will hopefully\",\n \"for annotating/rtyping in several phases: calling # a graph that has already been\",\n \"self.annotation(flowgraph.getreturnvar()) def gettype(self, variable): \\\"\\\"\\\"Return the known type of a control flow graph\",\n \"complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy\",\n \"block_subset is None: graphs = self.translator.graphs else: graphs = {} for block in\",\n \"\\\"\\\"\\\"Process pending blocks until none is left.\\\"\\\"\\\" while True: self.complete_pending_blocks() self.policy.no_more_blocks_to_annotate(self) if not\",\n \"complete_now=True, main_entry_point=False): \\\"\\\"\\\"Recursively build annotations about the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType),\",\n \"not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s = []\",\n \"#raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation\",\n \"block in self.notify: # reflow from certain positions when this block is done\",\n \"for a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)]\",\n \"graph-containing-block: # analysis done (at least until we find we must generalize the\",\n \"newgraphs else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values()\",\n \"not dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {} return ret\",\n \"#___ medium-level interface ____________________________ def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self,\",\n \"of graphs that have blocked blocks # --- end of debugging information ---\",\n \"processblock(). e.opindex = i raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: #\",\n \"if policy is None: from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # XXX\",\n \"len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph\",\n \"= [link for link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op\",\n \"pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface for annotator.bookkeeper _______\",\n \"on operations ______ def consider_op(self, op): # let's be careful about avoiding propagated\",\n \"inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s) #___ creating the annotations based on\",\n \"operations! for a, s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg)\",\n \"def addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register\",\n \"[link for link in block.exits if link.exitcase is not None] elif e.op.opname in\",\n \"pos=None): if pos is None: try: pos = self.bookkeeper.position_key except AttributeError: pos =\",\n \"= [self.annotated[block] for block in self.added_blocks] newgraphs = dict.fromkeys(newgraphs) got_blocked_blocks = False in\",\n \"graph) else: callback = whence callpositions[callback] = True # generalize the function's input\",\n \"inputcells, complete_now=False) self.complete_helpers(policy) return graph def complete_helpers(self, policy): saved = self.policy, self.added_blocks self.policy\",\n \"def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed notify bookkeeper frozen policy added_blocks\\\"\\\"\\\".split()\",\n \"s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self,\",\n \"is not None: opid = \\\" op=%d\\\" % i return repr(graph) + blk\",\n \"followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set of\",\n \"got %r' % (arg,)) def binding(self, arg): \\\"Gives the SomeValue corresponding to the\",\n \"note that UnionError is a subclass e.source = gather_error(self, graph, block, i) raise\",\n \"# the input variables of the block have bindings but we # still\",\n \"# some blocks are partially annotated if op.result.annotation is None: break # ignore\",\n \"link.target, inputs_s) def follow_raise_link(self, graph, link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value\",\n \"seen self.added_blocks = None # see processblock() below self.links_followed = {} # set\",\n \"a graph that has already been rtyped. Safety-check the new # annotations that\",\n \"annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const = s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata)\",\n \"assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() #\",\n \"creating the annotations based on operations ______ def consider_op(self, op): # let's be\",\n \"s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that try to\",\n \"them for block in newblocks: for op in block.operations: if op.opname in ('simple_call',\",\n \"the specific entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy\",\n \"-1) resultcell = op.consider(self) if resultcell is None: resultcell = s_ImpossibleValue elif resultcell\",\n \"= {} # set of blocks already seen self.added_blocks = None # see\",\n \"pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import Variable, Constant, checkgraph\",\n \"None) def bindinputargs(self, graph, block, inputcells): # Create the initial bindings for the\",\n \"types from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair\",\n \"tuple): parent_graph, parent_block, parent_index = whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag)\",\n \"blocked blocks # --- end of debugging information --- self.frozen = False if\",\n \"block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not None:\",\n \"addpendinggraph(self, flowgraph, inputcells): self.addpendingblock(flowgraph, flowgraph.startblock, inputcells) def addpendingblock(self, graph, block, cells): \\\"\\\"\\\"Register an\",\n \"s_ImpossibleValue, SomeInstance, intersection, difference) from rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log\",\n \"policy is None: from rpython.annotator.policy import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy =\",\n \"used by rpython.annlowlevel to # detect which are the new blocks that annotating\",\n \"bookkeeper frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value in ret.items(): if\",\n \"= block.operations[i] with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not\",\n \"TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got %r\\\" % (variable,)) def getuserclassdefinitions(self): \\\"\\\"\\\"Return\",\n \"apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of:\",\n \"pass impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out,\",\n \"type of a control flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant):\",\n \"which is immediately caught by # an exception handler. We then only follow\",\n \"[] renaming = defaultdict(list) for v_out, v_input in zip(link.args, link.target.inputargs): renaming[v_out].append(v_input) for v_out,\",\n \"if the merged cells changed, we must redo the analysis if unions !=\",\n \"defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error,\",\n \"Return the annotation for all exceptions that `operation` may raise. \\\"\\\"\\\" can_only_throw =\",\n \"been followed self.notify = {} # {block: {positions-to-reflow-from-when-done}} self.fixed_graphs = {} # set\",\n \"input arguments and set their type args_s = [self.typeannotation(t) for t in input_arg_types]\",\n \"-> SomeBool(const=False) ... # boom -- in the assert of setbinding() for arg\",\n \"initial bindings for the input args of a block. assert len(block.inputargs) == len(inputcells)\",\n \"graph, block): # Important: this is not called recursively. # self.flowin() can only\",\n \"assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s =\",\n \"handler. We then only follow the exceptional # branches. exits = [link for\",\n \"policy): desc = self.bookkeeper.getdesc(function) prevpolicy = self.policy self.policy = policy self.bookkeeper.enter(None) try: return\",\n \"!= '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface for\",\n \"functions actually never do, they always raise exceptions) return s_ImpossibleValue def reflowfromposition(self, position_key):\",\n \"in the block. # * self.annotated[block] == graph-containing-block: # analysis done (at least\",\n \"annotations that are passed in, and don't annotate the old # graph --\",\n \"exception handler. We then only follow the exceptional # branches. exits = [link\",\n \"results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue corresponding to the\",\n \"assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block]\",\n \"reflowpendingblock(self, graph, block): assert not self.frozen assert graph not in self.fixed_graphs self.pendingblocks[block] =\",\n \"self.binding(block.exitswitch) if s_exitswitch.is_constant(): exits = [link for link in exits if link.exitcase ==\",\n \"# see processblock() below self.links_followed = {} # set of links that have\",\n \"the block. # * self.annotated[block] == False: # the input variables of the\",\n \"callback(): whence(self, graph) else: callback = whence callpositions[callback] = True # generalize the\",\n \"def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in\",\n \"# ignore links that try to pass impossible values if s_out == s_ImpossibleValue:\",\n \"rpython.annotator.bookkeeper import Bookkeeper from rpython.rtyper.normalizecalls import perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block\",\n \"break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s [%s]>\\\" %(break_at, self.op) __str__ = __repr__\",\n \"annmodel.UnionError as e: # Add source code to the UnionError e.source = '\\\\n'.join(source_lines(graph,\",\n \"space. These are the operations for # which it is fine to always\",\n \"s_newarg in zip(block.inputargs, cells): s_oldarg = self.binding(a) assert annmodel.unionof(s_oldarg, s_newarg) == s_oldarg else:\",\n \"doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if\",\n \"graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't reach any return\",\n \"except annmodel.UnionError as e: # Add source code to the UnionError e.source =\",\n \"description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side\",\n \"+ blk + opid def flowin(self, graph, block): try: i = 0 while\",\n \"collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error\",\n \"must flowin. self.blocked_blocks[block] = (graph, None) def mergeinputargs(self, graph, block, inputcells): # Merge\",\n \"new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out,\",\n \"dict. please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___\",\n \"don't annotate the old # graph -- it's already low-level operations! for a,\",\n \"return s_out def whereami(self, position_key): graph, block, i = position_key blk = \\\"\\\"\",\n \"for key, value in ret.items(): if key not in attrs: assert type(value) is\",\n \"hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) flowgraph, inputs_s = self.get_call_parameters(function, args_s, policy) if main_entry_point:\",\n \"s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True self.addpendingblock(graph, link.target,\",\n \"as e: self.annotated[block] = False # failed, hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex)\",\n \"del self.blocked_blocks[block] try: self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False #\",\n \"# The dict 'added_blocks' is used by rpython.annlowlevel to # detect which are\",\n \"bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs =\",\n \"These are the operations for # which it is fine to always raise\",\n \"object space. These are the operations for # which it is fine to\",\n \"reflow whenever the # return block of this graph has been analysed. callpositions\",\n \"block) def call_sites(self): newblocks = self.added_blocks if newblocks is None: newblocks = self.annotated\",\n \"renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell = annmodel.SomeBool() if s_out.is_constant(): newcell.const =\",\n \"block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as\",\n \"reflow from certain positions when this block is done for callback in self.notify[block]:\",\n \"callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) #\",\n \"= self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?': pos =\",\n \"elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the operation cannot succeed\",\n \"AnnotatorPolicy() else: self.policy = policy if bookkeeper is None: bookkeeper = Bookkeeper(self) self.bookkeeper\",\n \"None), None) -> SomeBool(const=False) ... # boom -- in the assert of setbinding()\",\n \"break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s [%s]>\\\" %(break_at,\",\n \"is None: # interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext()\",\n \"please update %s.__getstate__\\\" % (key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience\",\n \"def reflowfromposition(self, position_key): graph, block, index = position_key self.reflowpendingblock(graph, block) def call_sites(self): newblocks\",\n \"block_subset is None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph,\",\n \"are the operations for # which it is fine to always raise an\",\n \"existing input # variables. oldcells = [self.binding(a) for a in block.inputargs] try: unions\",\n \"a in block.inputargs] try: unions = [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except\",\n \"swallow the BlockedInference and that's it. # About 'next': see test_annotate_iter_empty_container(). return else:\",\n \"by rpython.annlowlevel to # detect which are the new blocks that annotating an\",\n \"e.source = gather_error(self, graph, block, i) raise else: # dead code removal: don't\",\n \"case is None: self.follow_link(graph, link, {}) continue if s_exception == s_ImpossibleValue: break s_case\",\n \"validate(self): \\\"\\\"\\\"Check that the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives\",\n \"isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell = op.consider(self) if resultcell is None:\",\n \"rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks\",\n \"entry point.\\\"\\\"\\\" assert isinstance(function, types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy =\",\n \"s_old = arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does\",\n \"several phases: calling # a graph that has already been rtyped. Safety-check the\",\n \"callback = whence callpositions[callback] = True # generalize the function's input arguments self.addpendingblock(graph,\",\n \"pos != '?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface\",\n \"of a block. assert len(block.inputargs) == len(inputcells) for a, cell in zip(block.inputargs, inputcells):\",\n \"types.FunctionType), \\\"fix that!\\\" from rpython.annotator.policy import AnnotatorPolicy policy = AnnotatorPolicy() # make input\",\n \"if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable\",\n \"of the call operations in sync # with the flow object space. These\",\n \"unions != oldcells: self.bindinputargs(graph, block, unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'):\",\n \"else: newgraphs = self.translator.graphs #all of them got_blocked_blocks = False in self.annotated.values() if\",\n \"hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of += renaming[v] assert\",\n \"See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has\",\n \"block.operations[i:i+1] = new_ops if not new_ops: continue new_ops[-1].result = op.result op = new_ops[0]\",\n \"hopefully temporarily self.blocked_blocks[block] = (graph, e.opindex) except Exception as e: # hack for\",\n \"following information is recorded for debugging --- self.blocked_graphs = {} # set of\",\n \"perform_normalizations log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description in\",\n \"= [annmodel.unionof(c1,c2) for c1, c2 in zip(oldcells,inputcells)] except annmodel.UnionError as e: # Add\",\n \"self.pendingblocks: break # finished # make sure that the return variables of all\",\n \"make input arguments and set their type args_s = [self.typeannotation(t) for t in\",\n \"XXX warning, keep the name of the call operations in sync # with\",\n \"set of links that have ever been followed self.notify = {} # {block:\",\n \"setattr(e, '__annotator_block', block) raise # The dict 'added_blocks' is used by rpython.annlowlevel to\",\n \"= prevpolicy def annotate_helper(self, function, args_s, policy=None): if policy is None: from rpython.annotator.policy\",\n \"AnnotatorPolicy policy = AnnotatorPolicy() # make input arguments and set their type args_s\",\n \"= Bookkeeper(self) self.bookkeeper = bookkeeper def __getstate__(self): attrs = \\\"\\\"\\\"translator pendingblocks annotated links_followed\",\n \"as e: if e.op is block.raising_op: # this is the case where the\",\n \"setbinding(self, arg, s_value): s_old = arg.annotation if s_old is not None: if not\",\n \"in exits: constraints = knowntypedata.get(link.exitcase, {}) self.follow_link(graph, link, constraints) if block in self.notify:\",\n \"variable.annotation if s_variable: return s_variable.knowntype else: return object else: raise TypeError(\\\"Variable or Constant\",\n \"of setbinding() for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1)\",\n \"opindex def __repr__(self): if not self.break_at: break_at = \\\"?\\\" else: break_at = self.annotator.whereami(self.break_at)\",\n \"as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue, SomeInstance, intersection, difference) from\",\n \"graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif isinstance(variable, Variable):\",\n \"graph, block, inputcells): # Merge the new 'cells' with each of the block's\",\n \"return self.build_graph_types(flowgraph, inputs_s, complete_now=complete_now) def get_call_parameters(self, function, args_s, policy): desc = self.bookkeeper.getdesc(function) prevpolicy\",\n \"exits: case = link.exitcase if case is None: self.follow_link(graph, link, {}) continue if\",\n \"states: # * block not in self.annotated: # never seen the block. #\",\n \"expected, got %r' % (arg,)) def binding(self, arg): \\\"Gives the SomeValue corresponding to\",\n \"try: return self.binding(v) except KeyError: # the function didn't reach any return statement\",\n \"len(inputcells) == nbarg # wrong number of args # register the entry point\",\n \"= arg.annotation if s_old is not None: if not s_value.contains(s_old): log.WARNING(\\\"%s does not\",\n \"try: i = 0 while i < len(block.operations): op = block.operations[i] with self.bookkeeper.at_position((graph,\",\n \"translator self.pendingblocks = {} # map {block: graph-containing-it} self.annotated = {} # set\",\n \"helper creates. if self.added_blocks is not None: self.added_blocks[block] = True def reflowpendingblock(self, graph,\",\n \"for arg in op.args: if isinstance(self.annotation(arg), annmodel.SomeImpossibleValue): raise BlockedInference(self, op, -1) resultcell =\",\n \"the exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable): s_exitswitch =\",\n \"hack for debug tools only if not hasattr(e, '__annotator_block'): setattr(e, '__annotator_block', block) raise\",\n \"len(self.blocked_blocks) text = format_blocked_annotation_error(self, self.blocked_blocks) #raise SystemExit() raise annmodel.AnnotatorError(text) for graph in newgraphs:\",\n \"# make sure that the return variables of all graphs is annotated if\",\n \"in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False # must flowin. self.blocked_blocks[block] =\",\n \"= TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {} # map\",\n \"resultcell is None: resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op,\",\n \"recursively. # self.flowin() can only issue calls to self.addpendingblock(). # The analysis of\",\n \"object else: raise TypeError(\\\"Variable or Constant instance expected, \\\" \\\"got %r\\\" % (variable,))\",\n \"recursivecall(self, graph, whence, inputcells): if isinstance(whence, tuple): parent_graph, parent_block, parent_index = whence tag\",\n \"annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\" def __init__(self, translator=None, policy=None, bookkeeper=None): import\",\n \"= op self.opindex = opindex def __repr__(self): if not self.break_at: break_at = \\\"?\\\"\",\n \"constraints.items(): new_vs = renaming.get(v, []) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert\",\n \"s_out = self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target,\",\n \"else: callback = whence callpositions[callback] = True # generalize the function's input arguments\",\n \"if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph =\",\n \"s_out def whereami(self, position_key): graph, block, i = position_key blk = \\\"\\\" if\",\n \"Variable): self.setbinding(v_last_exc_type, typeof([v_last_exc_value])) inputs_s = [] renaming = defaultdict(list) for v_out, v_input in\",\n \"# XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph, inputcells = self.get_call_parameters(function, args_s, policy)\",\n \"= \\\" op=%d\\\" % i return repr(graph) + blk + opid def flowin(self,\",\n \"s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link:\",\n \"s_out.const s_out = newcell s_out.set_knowntypedata(renamed_knowntypedata) return s_out def whereami(self, position_key): graph, block, i\",\n \"the block have bindings but we # still have to consider all the\",\n \"frozen policy added_blocks\\\"\\\"\\\".split() ret = self.__dict__.copy() for key, value in ret.items(): if key\",\n \"self.bindinputargs(graph, block, cells) else: self.mergeinputargs(graph, block, cells) if not self.annotated[block]: self.pendingblocks[block] = graph\",\n \"self.annotated = {} # set of blocks already seen self.added_blocks = None #\",\n \"tuple): self.reflowfromposition(callback) # callback is a position else: callback() def follow_link(self, graph, link,\",\n \"arg.annotation = s_value def warning(self, msg, pos=None): if pos is None: try: pos\",\n \"= whence tag = parent_block, parent_index self.translator.update_call_graph(parent_graph, graph, tag) # self.notify[graph.returnblock] is a\",\n \"Variable or Constant.\\\" if isinstance(arg, Variable): return arg.annotation elif isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value)\",\n \"= getattr( block.exitswitch.annotation, \\\"knowntypedata\\\", {}) else: knowntypedata = {} for link in exits:\",\n \"resultcell = s_ImpossibleValue elif resultcell == s_ImpossibleValue: raise BlockedInference(self, op, -1) # the\",\n \"raise except annmodel.HarmlesslyBlocked: return except annmodel.AnnotatorError as e: # note that UnionError is\",\n \"def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def setbinding(self, arg, s_value): s_old = arg.annotation\",\n \"if v.annotation is None: self.setbinding(v, s_ImpossibleValue) def validate(self): \\\"\\\"\\\"Check that the annotation results\",\n \"blocks self.simplify(block_subset=self.added_blocks) finally: self.policy, self.added_blocks = saved def build_graph_types(self, flowgraph, inputcells, complete_now=True): checkgraph(flowgraph)\",\n \"return self.binding(v) except KeyError: # the function didn't reach any return statement so\",\n \"currently blocked, and that it should try to progress elsewhere.\\\"\\\"\\\" def __init__(self, annotator,\",\n \"# make input arguments and set their type args_s = [self.typeannotation(t) for t\",\n \"len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False #\",\n \"from rpython.annotator import model as annmodel, signature from rpython.annotator.model import ( typeof, s_ImpossibleValue,\",\n \"for graph in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v, s_ImpossibleValue)\",\n \"can result in violations of the # more general results invariant: e.g. if\",\n \"in block.operations: if op.opname in ('simple_call', 'call_args'): yield op # some blocks are\",\n \"'?': pos = self.whereami(pos) log.WARNING(\\\"%s/ %s\\\" % (pos, msg)) #___ interface for annotator.bookkeeper\",\n \"the old # graph -- it's already low-level operations! for a, s_newarg in\",\n \"engine that the situation is currently blocked, and that it should try to\",\n \"block, done in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text\",\n \"None: perform_normalizations(self) #___ flowing annotations in blocks _____________________ def processblock(self, graph, block): #\",\n \"in constraints: s_constraint = constraints[v_out] s_out = pair(s_out, s_constraint).improve() # ignore links that\",\n \"self.bookkeeper.new_exception(can_only_throw) class BlockedInference(Exception): \\\"\\\"\\\"This exception signals the type inference engine that the situation\",\n \"blocks _____________________ def processblock(self, graph, block): # Important: this is not called recursively.\",\n \"annotations based on operations ______ def consider_op(self, op): # let's be careful about\",\n \"the function didn't reach any return statement so far. # (some functions actually\",\n \"return repr(graph) + blk + opid def flowin(self, graph, block): try: i =\",\n \"has been analysed. callpositions = self.notify.setdefault(graph.returnblock, {}) if whence is not None: if\",\n \"graphs[graph] = True for graph in graphs: simplify.eliminate_empty_blocks(graph) self.bookkeeper.compute_at_fixpoint() if block_subset is None:\",\n \"e: # note that UnionError is a subclass e.source = gather_error(self, graph, block,\",\n \"# ignore the unannotated part #___ simplification (should be moved elsewhere?) _______ def\",\n \"if block_subset is None: graphs = self.translator.graphs else: graphs = {} for block\",\n \"def consider_op(self, op): # let's be careful about avoiding propagated SomeImpossibleValues # to\",\n \"[link for link in exits if link.exitcase == s_exitswitch.const] if block.canraise: op =\",\n \"import AnnotatorPolicy self.policy = AnnotatorPolicy() else: self.policy = policy if bookkeeper is None:\",\n \"else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells) else:\",\n \"got_blocked_blocks: for graph in self.blocked_graphs.values(): self.blocked_graphs[graph] = True blocked_blocks = [block for block,\",\n \"is None: raise KeyError return s_arg def typeannotation(self, t): return signature.annotation(t, self.bookkeeper) def\",\n \"Create the initial bindings for the input args of a block. assert len(block.inputargs)\",\n \"annmodel.AnnotatorError(text) for graph in newgraphs: v = graph.getreturnvar() if v.annotation is None: self.setbinding(v,\",\n \"s_oldarg else: assert not self.frozen if block not in self.annotated: self.bindinputargs(graph, block, cells)\",\n \"log = AnsiLogger(\\\"annrpython\\\") class RPythonAnnotator(object): \\\"\\\"\\\"Block annotator for RPython. See description in doc/translation.txt.\\\"\\\"\\\"\",\n \"self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v = graph.getreturnvar() try:\",\n \"rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines)\",\n \"s_constraint).improve() # ignore links that try to pass impossible values if s_out ==\",\n \"from collections import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from\",\n \"{} # map {block: graph-containing-it} self.annotated = {} # set of blocks already\",\n \"isinstance(arg, Constant): return self.bookkeeper.immutablevalue(arg.value) else: raise TypeError('Variable or Constant expected, got %r' %\",\n \"three states: # * block not in self.annotated: # never seen the block.\",\n \"link, s_last_exc_value): v_last_exc_type = link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and\",\n \"policy): saved = self.policy, self.added_blocks self.policy = policy try: self.added_blocks = {} self.complete()\",\n \"blk = \\\"\\\" if block: at = block.at() if at: blk = \\\"\",\n \"self.flowin(graph, block) except BlockedInference as e: self.annotated[block] = False # failed, hopefully temporarily\",\n \"(isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert v_last_exc_type and v_last_exc_value if isinstance(v_last_exc_value, Variable):\",\n \"cells) if not self.annotated[block]: self.pendingblocks[block] = graph def complete_pending_blocks(self): while self.pendingblocks: block, graph\",\n \"in block.exits if link.exitcase is not None] elif e.op.opname in ('simple_call', 'call_args', 'next'):\",\n \"= True s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) if ignore_link: return self.links_followed[link] = True\",\n \"# generalize the function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current)\",\n \"with self.bookkeeper.at_position((graph, block, i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1]\",\n \"constraints): assert not (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) ignore_link = False inputs_s\",\n \"the call operations in sync # with the flow object space. These are\",\n \"unions) def apply_renaming(self, s_out, renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v\",\n \"import AnnotatorPolicy policy = AnnotatorPolicy() # XXX hack annmodel.TLS.check_str_without_nul = ( self.translator.config.translation.check_str_without_nul) graph,\",\n \"self.added_blocks is not None: newgraphs = [self.annotated[block] for block in self.added_blocks] newgraphs =\",\n \"# the operation cannot succeed assert isinstance(resultcell, annmodel.SomeObject) assert isinstance(op.result, Variable) self.setbinding(op.result, resultcell)\",\n \"\\\"?\\\" else: break_at = self.annotator.whereami(self.break_at) return \\\"<BlockedInference break_at %s [%s]>\\\" %(break_at, self.op) __str__\",\n \"complete_now=True): checkgraph(flowgraph) nbarg = len(flowgraph.getargs()) assert len(inputcells) == nbarg # wrong number of\",\n \"= graph.getreturnvar() try: return self.binding(v) except KeyError: # the function didn't reach any\",\n \"key not in attrs: assert type(value) is dict, ( \\\"%r is not dict.\",\n \"op.result.annotation is None: break # ignore the unannotated part #___ simplification (should be\",\n \"exits if the exitswitch # is known exits = block.exits if isinstance(block.exitswitch, Variable):\",\n \"= None self.op = op self.opindex = opindex def __repr__(self): if not self.break_at:\",\n \"control flow graph variable, defaulting to 'object'.\\\"\\\"\\\" if isinstance(variable, Constant): return type(variable.value) elif\",\n \"the annotation results are valid\\\"\\\"\\\" self.bookkeeper.check_no_flags_on_instances() def annotation(self, arg): \\\"Gives the SomeValue corresponding\",\n \"self.__dict__.copy() for key, value in ret.items(): if key not in attrs: assert type(value)\",\n \"interface for tests from rpython.translator.translator import TranslationContext translator = TranslationContext() translator.annotator = self\",\n \"whence(self, graph) else: callback = whence callpositions[callback] = True # generalize the function's\",\n \"merged cells changed, we must redo the analysis if unions != oldcells: self.bindinputargs(graph,\",\n \"i += 1 except BlockedInference as e: if e.op is block.raising_op: # this\",\n \"point into block with the given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: #\",\n \"[]) for new_v in new_vs: renamed_knowntypedata[value][new_v] = s assert isinstance(s_out, annmodel.SomeBool) newcell =\",\n \"in self.annotated.items() if done is False] assert len(blocked_blocks) == len(self.blocked_blocks) text = format_blocked_annotation_error(self,\",\n \"args # register the entry point self.addpendinggraph(flowgraph, inputcells) # recursively proceed until no\",\n \"(key, self.__class__.__name__)) ret[key] = {} return ret #___ convenience high-level interface __________________ def\",\n \"# with the flow object space. These are the operations for # which\",\n \"s_out = typeof(renaming[v_last_exc_value]) if isinstance(v_last_exc_type, Constant): s_out.const = v_last_exc_type.value elif v_last_exc_type.annotation.is_constant(): s_out.const =\",\n \"when this block is done for callback in self.notify[block]: if isinstance(callback, tuple): self.reflowfromposition(callback)\",\n \"function's input arguments self.addpendingblock(graph, graph.startblock, inputcells) # get the (current) return value v\",\n \"TranslationContext translator = TranslationContext() translator.annotator = self self.translator = translator self.pendingblocks = {}\",\n \"impossible values if s_out == s_ImpossibleValue: ignore_link = True s_out = self.apply_renaming(s_out, renaming)\",\n \"self.added_blocks = None # see processblock() below self.links_followed = {} # set of\",\n \"in block_subset: graph = self.annotated.get(block) if graph: graphs[graph] = True for graph in\",\n \"not contain %s\\\" % (s_value, s_old)) log.WARNING(\\\"%s\\\" % annmodel.unionof(s_value, s_old)) assert False arg.annotation\",\n \"get the (current) return value v = graph.getreturnvar() try: return self.binding(v) except KeyError:\",\n \"renaming): if hasattr(s_out, 'is_type_of'): renamed_is_type_of = [] for v in s_out.is_type_of: renamed_is_type_of +=\",\n \"# set of {blocked_block: (graph, index)} # --- the following information is recorded\",\n \"{} # set of {blocked_block: (graph, index)} # --- the following information is\",\n \"cases are problematic (but will hopefully be solved # later by reflowing). Throw\",\n \"from rpython.tool.pairtype import pair from rpython.tool.error import (format_blocked_annotation_error, gather_error, source_lines) from rpython.flowspace.model import\",\n \"the given input cells.\\\"\\\"\\\" if graph in self.fixed_graphs: # special case for annotating/rtyping\",\n \"= link.last_exception v_last_exc_value = link.last_exc_value assert (isinstance(link.exitcase, (types.ClassType, type)) and issubclass(link.exitcase, BaseException)) assert\",\n \"--- self.blocked_graphs = {} # set of graphs that have blocked blocks #\",\n \"code removal: don't follow all exits if the exitswitch # is known exits\",\n \"= self.annotation(v_out) s_out = self.apply_renaming(s_out, renaming) inputs_s.append(s_out) self.links_followed[link] = True self.addpendingblock(graph, link.target, inputs_s)\",\n \"{} # set of blocks already seen self.added_blocks = None # see processblock()\",\n \"e.source = '\\\\n'.join(source_lines(graph, block, None, long=True)) raise # if the merged cells changed,\",\n \"pos = self.bookkeeper.position_key except AttributeError: pos = '?' if pos != '?': pos\",\n \"points to this func which triggers a reflow whenever the # return block\",\n \"== len(inputcells) for a, cell in zip(block.inputargs, inputcells): self.setbinding(a, cell) self.annotated[block] = False\",\n \"import defaultdict from rpython.tool.ansi_print import AnsiLogger from rpython.tool.pairtype import pair from rpython.tool.error import\",\n \"policy=None, bookkeeper=None): import rpython.rtyper.extfuncregistry # has side effects if translator is None: #\"\n]","isConversational":false}}},{"rowIdx":296,"cells":{"ngram":{"kind":"list like","value":["'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None,","inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls =","state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id = id","'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key':","name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity =","'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id","Gets and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages:","{'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type':","class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_:","layout node is contribution are not. :type is_contribution: bool :param label: Label for","'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None,","'[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key':","self.groups = groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param","'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None,","for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if the","{'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type':","self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets extensions list",":param description: :type description: str :param is_default: :type is_default: bool :param is_enabled: :type","'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key':","{'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type':","description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension.","{'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None,","str :param locked: A value indicating whether any user operations are permitted on","\"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color: str :param description:","overridden by a child layout. :type overridden: bool \"\"\" _attribute_map = { 'groups':","'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__()","field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value = value","'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url',","of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type id:","{'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type':","= overridden self.visible = visible class Page(Model): \"\"\"Page. :param contribution: Contribution for the","'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key':","'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory',","self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system","cause incorrect behavior and will be lost if the code is regenerated. #","str :param type_id: :type type_id: str \"\"\" _attribute_map = { 'description': {'key': 'description',","'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'},","'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key':","the group. :type label: str :param order: Order in which the group should","\"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type':","} def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description =","self).__init__() self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution","= inherited self.is_contribution = is_contribution self.label = label self.locked = locked self.order =","id for the layout node. :type id: str :param overridden: A value indicating","self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str :param hidden:","name: :type name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param","'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible',","is_disabled: bool :param is_system: :type is_system: bool \"\"\" _attribute_map = { 'actions': {'key':","= description self.name = name self.projects = projects self.properties = properties self.reference_name =",":param is_system: :type is_system: bool \"\"\" _attribute_map = { 'actions': {'key': 'actions', 'type':","} def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id =","self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str :param name:","self.extensions = extensions self.pages = pages self.system_controls = system_controls class Group(Model): \"\"\"Group. :param","id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order = order",":param is_enabled: :type is_enabled: bool :param name: :type name: str \"\"\" _attribute_map =","bool :param order: Order in which the page should appear in the layout.","license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may",":type overriden: bool :param rank: :type rank: int :param url: :type url: str","id: str :param url: :type url: str \"\"\" _attribute_map = { 'id': {'key':","str :param field: :type field: str :param value: :type value: str \"\"\" _attribute_map","url: str \"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key':","node has been overridden by a child layout. :type overridden: bool :param visible:","'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key':","version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id","order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id =","label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height","the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of","self.locked = locked self.order = order self.overridden = overridden self.page_type = page_type self.sections",":type is_default: bool :param url: :type url: str \"\"\" _attribute_map = { 'behavior':","state_category: :type state_category: str :param url: :type url: str \"\"\" _attribute_map = {","order: int :param overridden: A value indicating whether this layout node has been","'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'}","name: str :param overriden: :type overriden: bool :param rank: :type rank: int :param",":type contribution_id: str :param height: The height for the contribution. :type height: int","extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls =","fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color","{'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type':",":param pages: Top level tabs of the layout. :type pages: list of :class:`Page","\"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type':","'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon':","'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None,","{'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type':","url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param","'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits':","url: :type url: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'},","str :param is_identity: :type is_identity: bool :param name: :type name: str :param type:",":param overriden: :type overriden: bool :param rank: :type rank: int :param url: :type","class Extension(Model): \"\"\"Extension. :param id: :type id: str \"\"\" _attribute_map = { 'id':","description self.id = id self.is_identity = is_identity self.name = name self.type = type","'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'},",":param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id:","self.id = id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param","contribution_id: str :param height: The height for the contribution. :type height: int :param","'[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None,","class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field: str","'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key':","self.is_default = is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution. :param","'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system':","layout. :type overridden: bool :param visible: A value indicating if the group should","self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors:","id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name =","description: str :param icon: :type icon: str :param id: :type id: str :param","'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name',",":param color: :type color: str :param description: :type description: str :param icon: :type","= behaviors self.class_ = class_ self.color = color self.description = description self.icon =","'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None):","list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits:","= is_contribution self.label = label self.locked = locked self.order = order self.overridden =","indicating whether any user operations are permitted on this page and the contents","self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description:","class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default","workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'},","= inherits self.name = name self.overriden = overriden self.rank = rank self.url =","'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key':","'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'},",":param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url:","locked: A value indicating whether any user operations are permitted on this page","{'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type':","node has been overridden by a child layout. :type overridden: bool :param read_only:","is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets extensions","page_type: The icon for the page. :type page_type: object :param sections: The sections","'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'}","str :param url: :type url: str \"\"\" _attribute_map = { 'id': {'key': 'id',","} def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description =","id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str :param","self.is_contribution = is_contribution self.label = label self.order = order self.overridden = overridden self.visible",":param id: :type id: str :param name: :type name: str :param order: :type","Group(Model): \"\"\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param","str \"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id',","str :param inherited: A value indicating whether this layout node has been inherited","# Changes may cause incorrect behavior and will be lost if the code","{'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type':","{'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type':","inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs",":param is_contribution: A value indicating if the layout node is contribution or not.","description: str :param id: :type id: str :param is_identity: :type is_identity: bool :param","self).__init__() self.contribution = contribution self.controls = controls self.height = height self.id = id","id for the layout node. :type id: str :param inherited: A value indicating",":param order: :type order: int :param state_category: :type state_category: str :param url: :type","'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order',","'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None,","self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference.","<work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id: str :param is_disabled:","url: :type url: str \"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'},","or not. :type visible: bool :param watermark: Watermark text for the textbox. :type",":param id: :type id: str :param is_identity: :type is_identity: bool :param name: :type","{'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type':","'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'},","value class Section(Model): \"\"\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param","self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system class","'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel,",":type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str","_attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'},",":type is_contribution: bool :param label: Label for the field :type label: str :param","= description self.id = id self.is_identity = is_identity self.name = name self.type =","{'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type':","} def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field =",":param inputs: A dictionary holding key value pairs for contribution inputs. :type inputs:","for the page. :type page_type: object :param sections: The sections of the page.",":type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the","list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param","project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT","= behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id:","label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type","{'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type':","{'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None,","= hidden self.id = id self.name = name self.order = order self.state_category =","'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} }","rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param","A value indicating whether any user operations are permitted on this page and","'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'},","= url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type",":type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout","{'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None,","of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color: str","'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'},","id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden = overridden","'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name',","= height self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label =","abstract: :type abstract: bool :param color: :type color: str :param description: :type description:",":param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str","{ 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key':","self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type","controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map =","name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str :param","overridden: bool :param page_type: The icon for the page. :type page_type: object :param","__init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page,","'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior","EDIT # Changes may cause incorrect behavior and will be lost if the","_attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension,","page. :type page_type: object :param sections: The sections of the page. :type sections:","the contribution. :type height: int :param inputs: A dictionary holding key value pairs","'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item':","name: :type name: str :param overriden: :type overriden: bool :param rank: :type rank:","layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states: list","_attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'},",":param visible: A value indicating if the group should be hidden or not.","= overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id:","} def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name","self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order = order self.overridden","int :param overridden: A value indicating whether this layout node has been overridden",":param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type","description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name =","layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key':","and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top","'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ =","'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key':",":type target_field: str :param value: :type value: str \"\"\" _attribute_map = { 'action_type':","id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution","'[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key':","sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str :param","int :param inputs: A dictionary holding key value pairs for contribution inputs. :type","'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def","'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key':","name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name:","'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None,","{'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type':","layout. This is expected to only be only set by the combiner. :type","= properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_:","'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None,","'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key':","{'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type':","ReferenceName that it inherits from :type inherits: str :param is_disabled: :type is_disabled: bool","# Generated file, DO NOT EDIT # Changes may cause incorrect behavior and","control is readonly. :type read_only: bool :param visible: A value indicating if the",":param extensions: Gets and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>`","order: Order in which the page should appear in the layout. :type order:","label: str :param metadata: Inner text of the control. :type metadata: str :param","RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field: str :param","reference_name: :type reference_name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},","The height for the contribution. :type height: int :param id: The id for",":type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id:","'[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key':","the contribution. :type height: int :param id: The id for the layout node.","{'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type':","'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key':","order: Order in which the group should appear in the section. :type order:","The sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible:","self.is_identity = is_identity self.name = name self.type = type self.url = url class",":type name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties:",":param url: :type url: str \"\"\" _attribute_map = { 'behavior': {'key': 'behavior', 'type':","'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order',","self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description:","WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id: str :param","{'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None):","self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object :param is_default:","'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def","{'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type':","fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type","class_ self.color = color self.description = description self.icon = icon self.id = id","is_default: :type is_default: bool :param url: :type url: str \"\"\" _attribute_map = {",":param value: :type value: str \"\"\" _attribute_map = { 'action_type': {'key': 'actionType', 'type':","self.is_disabled = is_disabled self.layout = layout self.name = name self.states = states self.url","super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color:","is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_","'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id',","the page should appear in the layout. :type order: int :param overridden: A",":param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \"\"\" _attribute_map =","self.order = order self.overridden = overridden self.page_type = page_type self.sections = sections self.visible","{'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None,","def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height =","self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param","color self.hidden = hidden self.id = id self.name = name self.order = order",":param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type","} def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages =","lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class","for the layout node. :type id: str :param inherited: A value indicating whether","'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key':","'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},","self.behavior_field_id = behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param","icon: :type icon: str :param id: :type id: str :param inherits: Parent WIT","'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None,","class Page(Model): \"\"\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>`",":type name: str :param url: :type url: str \"\"\" _attribute_map = { 'description':","'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label':","= rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str","= target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str","{'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None,","'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value',","id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden","{ 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key':","{ 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key':","self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param","layout node. :type id: str :param inherited: A value indicating whether this layout","_attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'},","groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node.","is_identity: bool :param name: :type name: str :param type: :type type: object :param","= is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets","'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None,","page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if","'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url':","'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'}","{'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type':",":type name: str :param overriden: :type overriden: bool :param rank: :type rank: int","'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order':","self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id:",":type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\" _attribute_map","{'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type':",":type overridden: bool :param read_only: A value indicating if the control is readonly.","'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key':","the layout. :type order: int :param overridden: A value indicating whether this layout","which the group should appear in the section. :type order: int :param overridden:","action_type: str :param target_field: :type target_field: str :param value: :type value: str \"\"\"","name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id =","self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class",":type condition_type: str :param field: :type field: str :param value: :type value: str","WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url: str \"\"\"","color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors",":type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states:",":type watermark: str \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type':","__init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None,","'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked':","= abstract self.color = color self.description = description self.fields = fields self.id =","class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default: bool","{ 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key':","'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None,","'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'},","'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} }","watermark: Watermark text for the textbox. :type watermark: str \"\"\" _attribute_map = {","be only set by the combiner. :type inherited: bool :param is_contribution: A value","'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id class","layout. :type overridden: bool \"\"\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'},","<work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type id: str :param","See License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated","'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}","'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None,","description: str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param","url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id:","\"\"\"FieldModel. :param description: :type description: str :param id: :type id: str :param is_identity:","name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name = name","str :param reference_name: :type reference_name: str \"\"\" _attribute_map = { 'description': {'key': 'description',","'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None):","the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type","sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A","metadata: str :param order: :type order: int :param overridden: A value indicating whether","= contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label =","bool :param is_enabled: :type is_enabled: bool :param name: :type name: str \"\"\" _attribute_map",":param class_: :type class_: object :param is_default: :type is_default: bool :param is_enabled: :type","'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'},","'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'},","<work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden: bool :param rank:","hidden: bool :param id: :type id: str :param name: :type name: str :param","group. :type label: str :param order: Order in which the group should appear","{'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None,","'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description':","= { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value':","{'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type':","dictionary holding key value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item:","of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value",":type color: str :param description: :type description: str :param fields: :type fields: list","{'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type':","= { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden':","= friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model):","self).__init__() self.description = description self.name = name self.projects = projects self.properties = properties",":param read_only: A value indicating if the control is readonly. :type read_only: bool","actions self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled","url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name = name self.url","the layout node is contribution or not. :type is_contribution: bool :param label: Label",":type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str",":param description: :type description: str :param id: :type id: str :param name: :type","= overridden self.read_only = read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model):","str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def __init__(self,","msrest.serialization import Model class Control(Model): \"\"\"Control. :param contribution: Contribution for the control. :type","{'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__()","'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity',","{'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type':","value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating",":param inherited: A value indicating whether this layout node has been inherited from","def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description","= reference_name class Extension(Model): \"\"\"Extension. :param id: :type id: str \"\"\" _attribute_map =","is_disabled self.layout = layout self.name = name self.states = states self.url = url",":type description: str :param id: :type id: str :param name: :type name: str","label: Label for the field :type label: str :param metadata: Inner text of","str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name:","bool :param url: :type url: str \"\"\" _attribute_map = { 'behavior': {'key': 'behavior',","{'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None,","is_identity self.name = name self.type = type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel.","'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'},","class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color: str","'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id':","icon self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout","'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name':","'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType',","from a parent layout. This is expected to only be only set by","'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name':","= read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description:","'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None,","{'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type':","root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT #","= type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list","id: str :param name: :type name: str :param url: :type url: str \"\"\"","self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_:","class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str :param id: :type id: str","type: object :param url: :type url: str \"\"\" _attribute_map = { 'description': {'key':","self.order = order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param","contribution are not. :type is_contribution: bool :param label: The label for the page.",":param description: :type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>`","} def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color","= id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order =","'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self,","rank: int :param url: :type url: str \"\"\" _attribute_map = { 'abstract': {'key':","order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type","field: str :param value: :type value: str \"\"\" _attribute_map = { 'condition_type': {'key':","{'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type':","str :param version: :type version: str \"\"\" _attribute_map = { 'class_': {'key': 'class',","by a child layout. :type overridden: bool :param visible: A value indicating if","'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self,",":type value: str \"\"\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field':","bool :param is_contribution: A value indicating if the layout node is contribution or","id: :type id: str :param name: :type name: str :param url: :type url:","{'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None,","'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name","'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections',","} def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id","def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default","bool :param rank: :type rank: int :param url: :type url: str \"\"\" _attribute_map","'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }",":type id: str :param name: :type name: str :param order: :type order: int","of the control, for html controls. :type height: int :param id: The id","contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs","Changes may cause incorrect behavior and will be lost if the code is","the control, for html controls. :type height: int :param id: The id for","\"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field: str :param value:",":param version: :type version: str \"\"\" _attribute_map = { 'class_': {'key': 'class', 'type':","= visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str","str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url:","class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id: str","if the layout node is contribution or not. :type is_contribution: bool :param label:",":type id: str :param is_identity: :type is_identity: bool :param name: :type name: str","control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type:",":param contribution_id: The id for the contribution. :type contribution_id: str :param height: The","'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None,","'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description","'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'},","name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description","def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior,","'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None,","_attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'},","'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None,","= visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str :param name: :type","= { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value':","str :param name: :type name: str :param projects: :type projects: list of :class:`ProjectReference","{'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type':","'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id",":param description: :type description: str :param icon: :type icon: str :param id: :type","= { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color':","object :param sections: The sections of the page. :type sections: list of :class:`Section","description: :type description: str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id:",":param rank: :type rank: int :param url: :type url: str \"\"\" _attribute_map =","of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls",":param name: :type name: str :param order: :type order: int :param state_category: :type","{'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None):","'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel,","Inner text of the control. :type metadata: str :param order: :type order: int","hidden self.id = id self.name = name self.order = order self.state_category = state_category",":param friendly_name: :type friendly_name: str :param id: :type id: str :param is_disabled: :type","value indicating if the control is readonly. :type read_only: bool :param visible: A","self.sections = sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description:","self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str :param name:",":param type: :type type: object :param url: :type url: str \"\"\" _attribute_map =","reference_name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key':","label: The label for the page. :type label: str :param locked: A value","bool \"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height',","= actions self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled =","description: :type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param","'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits',","'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description","= projects self.properties = properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model):","def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id","page should be hidden or not. :type visible: bool \"\"\" _attribute_map = {","'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'},","= version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str :param id: :type","self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param color:","'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__()","'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None,","def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id =","is_contribution: bool :param label: Label for the group. :type label: str :param order:","description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type","is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \"\"\" _attribute_map = {","inherited self.is_contribution = is_contribution self.label = label self.order = order self.overridden = overridden",":param color: :type color: str :param hidden: :type hidden: bool :param id: :type","= { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name':","'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden',",":class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id: str \"\"\"","type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects = projects self.properties","'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url',","abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract","id: str :param url: :type url: str \"\"\" _attribute_map = { 'behavior_field_id': {'key':","= contribution self.controls = controls self.height = height self.id = id self.inherited =","properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type","# -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause incorrect","name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id","= label self.order = order self.overridden = overridden self.visible = visible class Page(Model):","bool :param is_system: :type is_system: bool \"\"\" _attribute_map = { 'actions': {'key': 'actions',","class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url: str","str \"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class',","child layout. :type overridden: bool :param read_only: A value indicating if the control",":param height: The height for the contribution. :type height: int :param inputs: A","'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None,","list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\" _attribute_map = {",":type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param","self.id = id self.is_identity = is_identity self.name = name self.type = type self.url","{'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type':","is expected to only be only set by the combiner. :type inherited: bool","rights reserved. # Licensed under the MIT License. See License.txt in the project","<work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id: str \"\"\" _attribute_map",":param label: Label for the group. :type label: str :param order: Order in","self.label = label self.order = order self.overridden = overridden self.visible = visible class","'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution':","{'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type':","{ 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key':","{'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None,","'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states':",":type reference_name: str :param type_id: :type type_id: str \"\"\" _attribute_map = { 'description':","= is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets extensions list :type","show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item","name self.overriden = overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField.","overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height = height","projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>`",":class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden: bool :param","layout node is contribution or not. :type is_contribution: bool :param label: Label for","{'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type':","'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description","ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str :param name: :type name: str :param","class Section(Model): \"\"\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id:","str :param height: Height of the control, for html controls. :type height: int","'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url',","bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version:","Generated file, DO NOT EDIT # Changes may cause incorrect behavior and will","contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution","'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","whether any user operations are permitted on this page and the contents of","value indicating if the page should be hidden or not. :type visible: bool","url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity = is_identity self.name","'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'}","class_: :type class_: object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled:","'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} }","'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order',","is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type","str :param description: :type description: str :param icon: :type icon: str :param id:","the contribution. :type contribution_id: str :param height: The height for the contribution. :type","'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} }","{'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type':","if the layout node is contribution are not. :type is_contribution: bool :param label:","id: str :param inherited: A value indicating whether this layout node has been","= is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for","str \"\"\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color',","'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self,","self.color = color self.description = description self.icon = icon self.id = id self.inherits","node is contribution are not. :type is_contribution: bool :param label: The label for","= { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects':","def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages","str :param url: :type url: str \"\"\" _attribute_map = { 'description': {'key': 'description',","'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None,","id: :type id: str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system:",":type read_only: bool :param visible: A value indicating if the control should be",":type url: str \"\"\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color':","\"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param url:",":type is_system: bool \"\"\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions':","text for the textbox. :type watermark: str \"\"\" _attribute_map = { 'contribution': {'key':","appear in the layout. :type order: int :param overridden: A value indicating whether","self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str :param is_default:","'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel,","{ 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key':","'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def","The label for the page. :type label: str :param locked: A value indicating","description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled","'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'},","'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key':","'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key':",":class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states: list of","description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors =","'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None,","'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} }","'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'}",":param id: :type id: str :param is_disabled: :type is_disabled: bool :param is_system: :type","self.type = type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions:","CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str :param name: :type name: str :param","visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height = height self.id","contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__()",":param label: Label for the field :type label: str :param metadata: Inner text","projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name:","locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id =","= state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference","str :param id: :type id: str :param is_identity: :type is_identity: bool :param name:","'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self,","= control_type self.height = height self.id = id self.inherited = inherited self.is_contribution =","} def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default","be put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height:","'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None,","'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id","the group should be hidden or not. :type visible: bool \"\"\" _attribute_map =","'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None,","id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url","visible: A value indicating if the group should be hidden or not. :type","{'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None,","color self.description = description self.icon = icon self.id = id self.inherits = inherits","'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def","'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior =","self).__init__() self.behavior = behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel.","controls self.height = height self.id = id self.inherited = inherited self.is_contribution = is_contribution",":type is_disabled: bool :param is_system: :type is_system: bool \"\"\" _attribute_map = { 'actions':","Order in which the group should appear in the section. :type order: int",":param sections: The sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>`","visible: A value indicating if the page should be hidden or not. :type","name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id:","str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name',","Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be",":param show_on_deleted_work_item: A value indicating if the contribution should be show on deleted",":param id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName that it","to be put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param","level tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls:",":param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden:","'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key':","self.hidden = hidden self.id = id self.name = name self.order = order self.state_category",":type is_identity: bool :param name: :type name: str :param type: :type type: object","target_field: :type target_field: str :param value: :type value: str \"\"\" _attribute_map = {","inherited from a parent layout. This is expected to only be only set","'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key':","description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id =","if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model):","{ 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key':",":type visible: bool :param watermark: Watermark text for the textbox. :type watermark: str","'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key':","= id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions:",":param height: Height of the control, for html controls. :type height: int :param","id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets","self.color = color self.description = description self.fields = fields self.id = id self.inherits","'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None,","id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution","behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url =","= reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object","target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param","not. :type visible: bool :param watermark: Watermark text for the textbox. :type watermark:","is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for the","'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url':","id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str","str :param id: :type id: str :param name: :type name: str :param url:","'[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None,","= label self.locked = locked self.order = order self.overridden = overridden self.page_type =","self.pages = pages self.system_controls = system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution for","'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}","\"\"\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type':","type: :type type: object :param url: :type url: str \"\"\" _attribute_map = {",":type height: int :param inputs: A dictionary holding key value pairs for contribution","= id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str","{'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type':","the page. :type label: str :param locked: A value indicating whether any user",":param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name:","'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id',","is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls","int :param url: :type url: str \"\"\" _attribute_map = { 'abstract': {'key': 'abstract',","id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name =","'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__()","for the group. :type label: str :param order: Order in which the group","\"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type':","indicating if the control is readonly. :type read_only: bool :param visible: A value","\"\"\"ProjectReference. :param description: :type description: str :param id: :type id: str :param name:","'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None,","value: str \"\"\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key':","'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self,","= inherited self.is_contribution = is_contribution self.label = label self.order = order self.overridden =","id: :type id: str :param is_identity: :type is_identity: bool :param name: :type name:","list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of","'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata',",":param url: :type url: str \"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type':","UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default: bool :param","bool :param visible: A value indicating if the control should be hidden or","'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key':","'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank',","_attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'},",":type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str","'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field","'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon',",":class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type pages: list","friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name","page_type: object :param sections: The sections of the page. :type sections: list of","are not. :type is_contribution: bool :param label: The label for the page. :type","'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default","'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id':","description self.name = name self.projects = projects self.properties = properties self.reference_name = reference_name","color: str :param description: :type description: str :param fields: :type fields: list of","'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'},","'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self,","'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled',","\"\"\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type':","= color self.hidden = hidden self.id = id self.name = name self.order =","contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior.","a child layout. :type overridden: bool :param read_only: A value indicating if the",":param id: :type id: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type':",":param locked: A value indicating whether any user operations are permitted on this","'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'},","<work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param","for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put","contribution self.controls = controls self.height = height self.id = id self.inherited = inherited","been overridden by a child layout. :type overridden: bool \"\"\" _attribute_map = {","is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str","behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel,","'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key':","str :param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param","is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets extensions list :type extensions:","version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str :param id: :type id:","'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None,","'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id':","should appear in the layout. :type order: int :param overridden: A value indicating","type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity = is_identity","behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url =","self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior","value indicating if the layout node is contribution or not. :type is_contribution: bool","self.order = order self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark",":param reference_name: :type reference_name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type':","= { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled':","= { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id':","group should be hidden or not. :type visible: bool \"\"\" _attribute_map = {","description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract","contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution","self.id = id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description:","str :param overriden: :type overriden: bool :param rank: :type rank: int :param url:","'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties',","self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str :param url:",":type inherited: bool :param is_contribution: A value indicating if the layout node is",":param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type",":type abstract: bool :param color: :type color: str :param description: :type description: str","overridden: bool :param visible: A value indicating if the group should be hidden","pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type","= parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str","self).__init__() self.description = description self.id = id self.is_identity = is_identity self.name = name","{ 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key':","{'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type':","This is expected to only be only set by the combiner. :type inherited:","type_id: :type type_id: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},","= inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool","is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \"\"\"Control. :param contribution:","list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type","super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height = height self.id =","'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly',","= inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order =","_attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'},","'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self,","'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}","id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str :param","class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id: str","'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type',","self.properties = properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param","= { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs':","order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id",":type type_id: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name':","'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible':","= name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for the contribution. :type","name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \"\"\"","contribution are not. :type is_contribution: bool :param label: Label for the group. :type","'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self,","{'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id =","= icon self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout =","self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata",":type overridden: bool \"\"\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id':","WIT Id/Internal ReferenceName that it inherits from :type inherits: str :param is_disabled: :type","key value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value","inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type",":class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type id: str","self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color self.description = description","'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def","overridden self.read_only = read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel.","} def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height","{'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type':","for the contribution. :type height: int :param id: The id for the layout","it inherits from :type inherits: str :param is_disabled: :type is_disabled: bool :param layout:","self.system_controls = system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution for the group. :type","description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id","super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value = value class Section(Model):","rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description = description","self.name = name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type:","super(ProcessModel, self).__init__() self.description = description self.name = name self.projects = projects self.properties =","groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the","set by the combiner. :type inherited: bool :param is_contribution: A value indicating if","'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'},","show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color:","in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height",":type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type","field: :type field: str :param value: :type value: str \"\"\" _attribute_map = {",":type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key': 'extensions',","'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'},",":class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls: list of",":type icon: str :param id: :type id: str :param inherits: Parent WIT Id/Internal","'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout':","contribution. :type height: int :param inputs: A dictionary holding key value pairs for","str :param order: Order in which the group should appear in the section.","str :param type: :type type: object :param url: :type url: str \"\"\" _attribute_map","system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution","self.name = name self.type = type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param",":param is_identity: :type is_identity: bool :param name: :type name: str :param type: :type","height: int :param inputs: A dictionary holding key value pairs for contribution inputs.","self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled","is_system: bool \"\"\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key':","'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls',","'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} }","'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'},","super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color self.description =","= extensions self.pages = pages self.system_controls = system_controls class Group(Model): \"\"\"Group. :param contribution:","super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id =","\"\"\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default: bool :param is_enabled:","url: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key':","'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type':","'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None,","class Group(Model): \"\"\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>`","__init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default =","<work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type id: str :param","id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls","= id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata =","= { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls':","height for the contribution. :type height: int :param id: The id for the","'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key':",":param control_type: Type of the control. :type control_type: str :param height: Height of","Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt","controls: Controls to be put in the group. :type controls: list of :class:`Control","'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions","{'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__()","contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of","str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param name:","'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'}","url: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key':","'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self,","'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states',","appear in the section. :type order: int :param overridden: A value indicating whether","super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description = description self.fields =","url: :type url: str \"\"\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'},","'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id","contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label","information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause","= fields self.id = id self.inherits = inherits self.name = name self.overriden =","\"\"\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type:","super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name =","a child layout. :type overridden: bool :param visible: A value indicating if the","id self.name = name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type","this page and the contents of this page :type locked: bool :param order:","inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>`","contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None):","'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type =","'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark',","visible class Page(Model): \"\"\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution","'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None,","the combiner. :type inherited: bool :param is_contribution: A value indicating if the layout","url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden:","'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None):","reference_name: str :param type_id: :type type_id: str \"\"\" _attribute_map = { 'description': {'key':","self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name = name","hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden =","self.class_ = class_ self.color = color self.description = description self.icon = icon self.id","groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden =","\"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type':","{'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type':",":param is_contribution: A value indicating if the layout node is contribution are not.","locked: bool :param order: Order in which the page should appear in the","id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits","FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets extensions list :type extensions: list of","<work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color: str :param description:",":type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden:","self.description = description self.fields = fields self.id = id self.inherits = inherits self.name","layout node. :type id: str :param overridden: A value indicating whether this layout","states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\" _attribute_map =","Order in which the page should appear in the layout. :type order: int","{'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type':","behaviors self.class_ = class_ self.color = color self.description = description self.icon = icon","id: :type id: str :param url: :type url: str \"\"\" _attribute_map = {","for html controls. :type height: int :param id: The id for the layout","FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type","for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes","url: :type url: str \"\"\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'},","parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled","# Licensed under the MIT License. See License.txt in the project root for","{'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups",":class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height: int :param","the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout","parent_process_type_id: str :param reference_name: :type reference_name: str \"\"\" _attribute_map = { 'description': {'key':","'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'},",":param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type",":type id: str :param inherited: A value indicating whether this layout node has","= { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name':","'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url =","the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating",":type is_enabled: bool :param name: :type name: str \"\"\" _attribute_map = { 'description':","{'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None,","= { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity':","} def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None,",":type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the","been overridden by a child layout. :type overridden: bool :param read_only: A value","incorrect behavior and will be lost if the code is regenerated. # --------------------------------------------------------------------------------------------","self.color = color self.hidden = hidden self.id = id self.name = name self.order","in which the group should appear in the section. :type order: int :param",":type control_type: str :param height: Height of the control, for html controls. :type","'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name',","\"\"\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type':","properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id: str","str :param url: :type url: str \"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId',","not. :type is_contribution: bool :param label: The label for the page. :type label:","contribution self.control_type = control_type self.height = height self.id = id self.inherited = inherited","'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'}","'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'},","{'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id","'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key':","overriden: :type overriden: bool :param rank: :type rank: int :param url: :type url:","control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control,",":param name: :type name: str :param type: :type type: object :param url: :type","'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description","self.contribution = contribution self.control_type = control_type self.height = height self.id = id self.inherited","{'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type':","'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden',",":type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name:","'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout',","def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class","'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None,","layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color","visible: bool :param watermark: Watermark text for the textbox. :type watermark: str \"\"\"","__init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__()","watermark: str \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key':","list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id:",":type state_category: str :param url: :type url: str \"\"\" _attribute_map = { 'color':","\"\"\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type':","reference_name: :type reference_name: str :param type_id: :type type_id: str \"\"\" _attribute_map = {","behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type","bool :param visible: A value indicating if the group should be hidden or","'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url',","name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key':","<work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str :param height: Height","= description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model):",":type name: str :param type: :type type: object :param url: :type url: str","str :param metadata: Inner text of the control. :type metadata: str :param order:","layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type","self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item","value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value = value class","'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference,","'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None,","and will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization","{ 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key':",":type name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default':","str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id:","def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions","of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id: str","bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id',","a child layout. :type overridden: bool \"\"\" _attribute_map = { 'groups': {'key': 'groups',","conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param","_attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'},","url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url = url class","_attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'},","inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ =","should be hidden or not. :type visible: bool \"\"\" _attribute_map = { 'contribution':","'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type =","system_controls: Headers controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\"","{'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type':","id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel.","inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution =","class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str :param name: :type name: str","bool :param name: :type name: str \"\"\" _attribute_map = { 'description': {'key': 'description',","icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors",":param target_field: :type target_field: str :param value: :type value: str \"\"\" _attribute_map =","'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None):","super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model):","'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None,","actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of","inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution =","name: :type name: str :param order: :type order: int :param state_category: :type state_category:","color: str :param hidden: :type hidden: bool :param id: :type id: str :param",":type overridden: bool :param page_type: The icon for the page. :type page_type: object","= is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param description:","'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None,","url: str \"\"\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key':","self.read_only = read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param","= { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url':","(c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See","description: str :param name: :type name: str :param projects: :type projects: list of","{'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type':","self.order = order self.overridden = overridden self.visible = visible class Page(Model): \"\"\"Page. :param","def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default =","'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color',","= id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name =","\"\"\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls:","Page(Model): \"\"\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param","inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden: bool","= type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object :param is_default: :type","-------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause incorrect behavior","{'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type':","str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties:","group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the","name: str :param type: :type type: object :param url: :type url: str \"\"\"","control_type: str :param height: Height of the control, for html controls. :type height:","child layout. :type overridden: bool :param page_type: The icon for the page. :type","'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None,","permitted on this page and the contents of this page :type locked: bool","'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'},","'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties':","The id for the layout node. :type id: str :param overridden: A value","} def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions =","= id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked =",":type rank: int :param url: :type url: str \"\"\" _attribute_map = { 'abstract':","code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \"\"\"Control. :param","'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","self.visible = visible class Page(Model): \"\"\"Page. :param contribution: Contribution for the page. :type","been overridden by a child layout. :type overridden: bool :param visible: A value","label self.metadata = metadata self.order = order self.overridden = overridden self.read_only = read_only","node. :type id: str :param inherited: A value indicating whether this layout node","id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel. :param description: :type description:","bool :param label: Label for the group. :type label: str :param order: Order","'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'},","state_category: str :param url: :type url: str \"\"\" _attribute_map = { 'color': {'key':",":type is_contribution: bool :param label: Label for the group. :type label: str :param","__init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value","super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution =","'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key':",":type id: str :param overridden: A value indicating whether this layout node has","be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model","overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default:","overriden: bool :param rank: :type rank: int :param url: :type url: str \"\"\"","{'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type':","page_type self.sections = sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type","id: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def","name: :type name: str :param type: :type type: object :param url: :type url:","contribution. :type contribution_id: str :param height: The height for the contribution. :type height:","'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'},","{'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None,","version: :type version: str \"\"\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'},","label: str :param locked: A value indicating whether any user operations are permitted","if the group should be hidden or not. :type visible: bool \"\"\" _attribute_map","inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution should","self.name = name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id for the contribution.","'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id","visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution","= color self.description = description self.fields = fields self.id = id self.inherits =","= url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default:","order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height =","\"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_:",":param id: :type id: str :param url: :type url: str \"\"\" _attribute_map =","under the MIT License. See License.txt in the project root for license information.","'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def","'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId',","class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str :param name: :type name: str","WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color: str :param","control_type self.height = height self.id = id self.inherited = inherited self.is_contribution = is_contribution","'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem',","= class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version =","the page should be hidden or not. :type visible: bool \"\"\" _attribute_map =","'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description =","only be only set by the combiner. :type inherited: bool :param is_contribution: A","{'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type':","def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field","'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url':","\"\"\"CreateProcessModel. :param description: :type description: str :param name: :type name: str :param parent_process_type_id:","{'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties,","this layout node has been overridden by a child layout. :type overridden: bool","class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden: bool","'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field","self).__init__() self.action_type = action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel.","name self.type = type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type","child layout. :type overridden: bool \"\"\" _attribute_map = { 'groups': {'key': 'groups', 'type':","'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None,","is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled =","'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id',",":param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name:","bool :param read_only: A value indicating if the control is readonly. :type read_only:","by a child layout. :type overridden: bool :param page_type: The icon for the","'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version':","'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference,","= description self.fields = fields self.id = id self.inherits = inherits self.name =","contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map =","str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param",":type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group.","<work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type pages: list of","'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None):","{'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type':",":param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls",":type order: int :param state_category: :type state_category: str :param url: :type url: str",":param description: :type description: str :param name: :type name: str :param projects: :type","been inherited from a parent layout. This is expected to only be only","control_type: Type of the control. :type control_type: str :param height: Height of the","{'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type':","def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default","will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import","\"\"\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id: str :param height:",":type description: str :param id: :type id: str :param is_identity: :type is_identity: bool","= { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id':","id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type","of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = {","def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field","'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self,","'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description","= contribution self.control_type = control_type self.height = height self.id = id self.inherited =","= conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system =","'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order':","'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__()","'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__()","<work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages',","= { 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__()","url: str \"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key':","overridden by a child layout. :type overridden: bool :param read_only: A value indicating","'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited',","'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None,",":param overridden: A value indicating whether this layout node has been overridden by","str \"\"\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault',","is_contribution: A value indicating if the layout node is contribution are not. :type","'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None,","system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls class","the layout node is contribution are not. :type is_contribution: bool :param label: Label","'[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key':","{'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type':","_attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'},","id self.name = name self.order = order self.state_category = state_category self.url = url","super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity = is_identity self.name =","'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name',","states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color","__init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model):","'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata':",":class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type id: str","{'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type","of the control. :type metadata: str :param order: :type order: int :param overridden:","= description self.is_default = is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model):",":type url: str \"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_':","conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system","'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} }",":type label: str :param order: Order in which the group should appear in","is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type name: str \"\"\"","name: str :param order: :type order: int :param state_category: :type state_category: str :param","'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled',",":param id: :type id: str :param name: :type name: str :param url: :type","'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id =","label self.order = order self.overridden = overridden self.visible = visible class Page(Model): \"\"\"Page.","_attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}","is_contribution self.label = label self.order = order self.overridden = overridden self.visible = visible","class FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str :param id: :type id: str","<work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should be hidden or","'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order':","show on deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id': {'key':","label for the page. :type label: str :param locked: A value indicating whether","FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str :param id: :type id: str :param","{'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type':","'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None,","'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def","import Model class Control(Model): \"\"\"Control. :param contribution: Contribution for the control. :type contribution:","= id class FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str :param id: :type",":class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>`","is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The","the control. :type control_type: str :param height: Height of the control, for html","overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited","'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections':","'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type","= is_contribution self.label = label self.metadata = metadata self.order = order self.overridden =","str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url',","value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field:","str :param order: :type order: int :param overridden: A value indicating whether this","self).__init__() self.abstract = abstract self.color = color self.description = description self.fields = fields","id self.inherits = inherits self.name = name self.overriden = overriden self.rank = rank","read_only: A value indicating if the control is readonly. :type read_only: bool :param","'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits',","page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node.",":param label: The label for the page. :type label: str :param locked: A","pages: Top level tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>`","def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None,","id: str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \"\"\"","{'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None,","def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None):","'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None,","= id self.inherits = inherits self.name = name self.overriden = overriden self.rank =","'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_","= name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param id:","str :param value: :type value: str \"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType',","'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank':","of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls: list","DO NOT EDIT # Changes may cause incorrect behavior and will be lost",":type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel","visible: A value indicating if the control should be hidden or not. :type",":type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits:","overridden by a child layout. :type overridden: bool :param visible: A value indicating","{'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type':",":param name: :type name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>`","'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel,","on this page and the contents of this page :type locked: bool :param","is_contribution: A value indicating if the layout node is contribution or not. :type",":param url: :type url: str \"\"\" _attribute_map = { 'color': {'key': 'color', 'type':","layout. :type overridden: bool :param read_only: A value indicating if the control is","'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type':","'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled',","indicating if the page should be hidden or not. :type visible: bool \"\"\"","{ 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key':","= system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution for the group. :type contribution:","'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \"\"\"",":class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group. :type controls:","'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits':","{ 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key':","is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity","__init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name","{'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type':","self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order = order self.overridden","MIT License. See License.txt in the project root for license information. # --------------------------------------------------------------------------------------------","'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'},","'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden':","'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None):","= overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str :param is_default: :type","indicating if the control should be hidden or not. :type visible: bool :param","of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages':","'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None,","from msrest.serialization import Model class Control(Model): \"\"\"Control. :param contribution: Contribution for the control.","The id for the layout node. :type id: str :param inherited: A value","'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None,",":type inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout","= { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited':","'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key':",":param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object","not. :type is_contribution: bool :param label: Label for the field :type label: str","'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description","Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the","'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None,","id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id","self.is_enabled = is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id: The id",":param url: :type url: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type':","or not. :type visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type':","whether this layout node has been overridden by a child layout. :type overridden:","value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value = value class","name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type","is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param","'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None,","self.height = height self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label","'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def","A value indicating if the contribution should be show on deleted workItem. :type","to only be only set by the combiner. :type inherited: bool :param is_contribution:","inherits from :type inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type","type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list of","_attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'},","description: :type description: str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled:",":param is_default: :type is_default: bool :param url: :type url: str \"\"\" _attribute_map =","{'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type':","has been overridden by a child layout. :type overridden: bool :param visible: A","visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key':","'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'},","that it inherits from :type inherits: str :param is_disabled: :type is_disabled: bool :param","class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions:","'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'}",":class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should be hidden","super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model):","inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type inherits: str :param","= order self.overridden = overridden self.visible = visible class Page(Model): \"\"\"Page. :param contribution:","condition_type: :type condition_type: str :param field: :type field: str :param value: :type value:","overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height","self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param field:","super(ProjectReference, self).__init__() self.description = description self.id = id self.name = name self.url =","{'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type","'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self,","description: :type description: str :param id: :type id: str :param name: :type name:","self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str :param id:","self.controls = controls self.height = height self.id = id self.inherited = inherited self.is_contribution","{'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior",":class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color: str :param","{'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__()","\"\"\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type':","'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None,","order: :type order: int :param overridden: A value indicating whether this layout node","\"\"\"Extension. :param id: :type id: str \"\"\" _attribute_map = { 'id': {'key': 'id',","_attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},","for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control.","controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution =","class_: object :param color: :type color: str :param description: :type description: str :param","\"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None):","'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order':","'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled',","order: :type order: int :param state_category: :type state_category: str :param url: :type url:",":type visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id':","id: str :param name: :type name: str :param order: :type order: int :param","\"\"\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field: str :param value:","'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'}","overridden: bool \"\"\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key':","is_system: :type is_system: bool \"\"\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'},","self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param id: :type id: str \"\"\" _attribute_map","contribution or not. :type is_contribution: bool :param label: Label for the field :type","contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group. :type","'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }","= metadata self.order = order self.overridden = overridden self.read_only = read_only self.visible =","= color self.description = description self.icon = icon self.id = id self.inherits =","id: str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type","{'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type':",":param name: :type name: str :param overriden: :type overriden: bool :param rank: :type","'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id':","object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id:","'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'},","Section(Model): \"\"\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The","'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId',","control, for html controls. :type height: int :param id: The id for the","bool :param name: :type name: str :param type: :type type: object :param url:","'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category':","= id self.name = name self.order = order self.state_category = state_category self.url =","this layout node has been inherited from a parent layout. This is expected","overridden: A value indicating whether this layout node has been overridden by a","str :param value: :type value: str \"\"\" _attribute_map = { 'action_type': {'key': 'actionType',","self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name","locked self.order = order self.overridden = overridden self.page_type = page_type self.sections = sections","= url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type","height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__()","visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key':","reserved. # Licensed under the MIT License. See License.txt in the project root",":param name: :type name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type':","'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self,","self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param",":param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str","indicating if the layout node is contribution or not. :type is_contribution: bool :param","is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution","\"\"\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions:","'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None):","'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key':","self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class","'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id =",":param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \"\"\" _attribute_map =","A value indicating whether this layout node has been overridden by a child","self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param id: :type id:","description: :type description: str :param icon: :type icon: str :param id: :type id:","self.id = id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id:",":param order: :type order: int :param overridden: A value indicating whether this layout","visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str :param","'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model):","sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level",":param abstract: :type abstract: bool :param color: :type color: str :param description: :type","'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None,","'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution',","'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None,",":type url: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url':","url: :type url: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},","layout node has been overridden by a child layout. :type overridden: bool :param","fields self.id = id self.inherits = inherits self.name = name self.overriden = overriden","= order self.overridden = overridden self.page_type = page_type self.sections = sections self.visible =","_attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'},",":type reference_name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name':","{'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type':","list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type","indicating whether this layout node has been inherited from a parent layout. This","value: :type value: str \"\"\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'},",":type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name:","A value indicating whether this layout node has been inherited from a parent","self.target_field = target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type:","RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field: str :param","'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key':","'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} }","'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__()","'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'},","not. :type visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'},","= url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type","url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param","'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution,","bool :param is_contribution: A value indicating if the layout node is contribution are","be show on deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id':",":param controls: Controls to be put in the group. :type controls: list of","of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference","order self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark = watermark","'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions","'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None,","'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None,","self.overridden = overridden self.page_type = page_type self.sections = sections self.visible = visible class","str \"\"\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden',","metadata: Inner text of the control. :type metadata: str :param order: :type order:","Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for","control should be hidden or not. :type visible: bool :param watermark: Watermark text","= controls self.height = height self.id = id self.inherited = inherited self.is_contribution =","group should appear in the section. :type order: int :param overridden: A value","'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key':",":param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties","reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects = projects","= pages self.system_controls = system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution for the","'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key':","'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'},","has been inherited from a parent layout. This is expected to only be","state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>`",":type label: str :param locked: A value indicating whether any user operations are","self.label = label self.locked = locked self.order = order self.overridden = overridden self.page_type","'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def","'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None,","put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The","'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label',","'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value',","value indicating whether this layout node has been inherited from a parent layout.","been overridden by a child layout. :type overridden: bool :param page_type: The icon","'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId',","'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible':","{ 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key':",":type friendly_name: str :param id: :type id: str :param is_disabled: :type is_disabled: bool","= id self.name = name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type:","control. :type metadata: str :param order: :type order: int :param overridden: A value","super(Section, self).__init__() self.groups = groups self.id = id self.overridden = overridden class UpdateProcessModel(Model):","self.description = description self.id = id self.name = name self.url = url class","= label self.metadata = metadata self.order = order self.overridden = overridden self.read_only =","name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color =","id class FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str :param id: :type id:","description: :type description: str :param id: :type id: str :param is_identity: :type is_identity:","= contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model):","if the control should be hidden or not. :type visible: bool :param watermark:","= is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution. :param contribution_id:","is_enabled: bool :param name: :type name: str \"\"\" _attribute_map = { 'description': {'key':","bool :param color: :type color: str :param description: :type description: str :param fields:","'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url',","{'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type':","= description self.id = id self.name = name self.url = url class RuleActionModel(Model):","of this page :type locked: bool :param order: Order in which the page","} def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None,","'[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout,","} def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id =","page should appear in the layout. :type order: int :param overridden: A value","A value indicating if the control should be hidden or not. :type visible:",":type url: str \"\"\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default':","<work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls: list of :class:`Control","url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field:","= field self.value = value class Section(Model): \"\"\"Section. :param groups: :type groups: list","condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value =","'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def","'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'},","'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def","'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def","url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param","height for the contribution. :type height: int :param inputs: A dictionary holding key","'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark':","Label for the group. :type label: str :param order: Order in which the","'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None,","{'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None):","= { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled':","self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id","of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name:","'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions =","self.abstract = abstract self.color = color self.description = description self.fields = fields self.id","should be show on deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map = {","is_contribution self.label = label self.locked = locked self.order = order self.overridden = overridden","self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and",":param state_category: :type state_category: str :param url: :type url: str \"\"\" _attribute_map =","bool :param page_type: The icon for the page. :type page_type: object :param sections:","'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key':","'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden':",":type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url:","control. :type control_type: str :param height: Height of the control, for html controls.",":type id: str :param url: :type url: str \"\"\" _attribute_map = { 'id':",":param hidden: :type hidden: bool :param id: :type id: str :param name: :type","'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} }","description self.is_default = is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \"\"\"WitContribution.","self.metadata = metadata self.order = order self.overridden = overridden self.read_only = read_only self.visible","parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str :param",":param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list","color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden","for the field :type label: str :param metadata: Inner text of the control.","group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the","inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order = order","'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'},","contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str :param",":param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str","behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from","\"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type':","the contents of this page :type locked: bool :param order: Order in which","of the control. :type control_type: str :param height: Height of the control, for","'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key':","str :param id: :type id: str :param is_disabled: :type is_disabled: bool :param is_system:","inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution should be show","projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects","{'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type':","_attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'},","'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None):",":type metadata: str :param order: :type order: int :param overridden: A value indicating","'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name':","'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'},","url: str \"\"\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key':","= parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param id: :type id: str",":type hidden: bool :param id: :type id: str :param name: :type name: str","self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked = locked self.order","by the combiner. :type inherited: bool :param is_contribution: A value indicating if the","for the page. :type label: str :param locked: A value indicating whether any","actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>`",":type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id:","'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name':","extensions self.pages = pages self.system_controls = system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution","'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked',",":param reference_name: :type reference_name: str :param type_id: :type type_id: str \"\"\" _attribute_map =","'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }","pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if",":type id: str :param name: :type name: str :param url: :type url: str","for the contribution. :type contribution_id: str :param height: The height for the contribution.","'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name',","name self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id = type_id","{'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type':","'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key':","the page. :type page_type: object :param sections: The sections of the page. :type","{'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type':","be hidden or not. :type visible: bool :param watermark: Watermark text for the",":type label: str :param metadata: Inner text of the control. :type metadata: str","projects self.properties = properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties.","'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key':","{'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type':","is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of","value: str \"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key':",":type id: str :param url: :type url: str \"\"\" _attribute_map = { 'behavior_field_id':","'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'},","url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type","for the layout node. :type id: str :param overridden: A value indicating whether",":type parent_process_type_id: str :param version: :type version: str \"\"\" _attribute_map = { 'class_':","{'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None,","inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param","'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled':","'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id =","{'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None,","whether this layout node has been inherited from a parent layout. This is","behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url: str","= class_ self.color = color self.description = description self.icon = icon self.id =","= url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>`",":class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str :param height:","{ 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key':",":param description: :type description: str :param name: :type name: str :param parent_process_type_id: :type","parent_process_type_id: str :param version: :type version: str \"\"\" _attribute_map = { 'class_': {'key':","super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height = height self.id =","{'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id","super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value = value class RuleConditionModel(Model):","'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel,","'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None,","are permitted on this page and the contents of this page :type locked:","'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups","__init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color","'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url',","indicating if the layout node is contribution are not. :type is_contribution: bool :param","'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'},","= value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type","any user operations are permitted on this page and the contents of this","'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url':","<work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param","= is_contribution self.label = label self.order = order self.overridden = overridden self.visible =","self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version","description self.fields = fields self.id = id self.inherits = inherits self.name = name","sections: The sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param","the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT",":type type: object :param url: :type url: str \"\"\" _attribute_map = { 'description':","id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str :param","parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id","__init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden","'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None,","{'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type':","layout node has been inherited from a parent layout. This is expected to","visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height = height","'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'}","'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__()","self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel","color: :type color: str :param description: :type description: str :param fields: :type fields:","def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description","node is contribution or not. :type is_contribution: bool :param label: Label for the","# -------------------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under","url: :type url: str \"\"\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'},","url: str \"\"\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key':","{'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type':","label: str :param order: Order in which the group should appear in the","'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}","'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'},","name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param id: :type","bool \"\"\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions',","'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None,",":type overridden: bool :param visible: A value indicating if the group should be","value indicating if the layout node is contribution are not. :type is_contribution: bool","__init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name",":type order: int :param overridden: A value indicating whether this layout node has","label: Label for the group. :type label: str :param order: Order in which","__init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions","url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description = description self.fields","'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description',","operations are permitted on this page and the contents of this page :type","'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible':","id: str :param is_identity: :type is_identity: bool :param name: :type name: str :param","'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'}","'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'},","'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} }","conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions","'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def","'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel,","'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None,","= locked self.order = order self.overridden = overridden self.page_type = page_type self.sections =","Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License.","int :param state_category: :type state_category: str :param url: :type url: str \"\"\" _attribute_map","indicating if the contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool","str \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType',",":type behavior_field_id: str :param id: :type id: str :param url: :type url: str","for the contribution. :type height: int :param inputs: A dictionary holding key value","'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url':","Parent WIT Id/Internal ReferenceName that it inherits from :type inherits: str :param is_disabled:","child layout. :type overridden: bool :param visible: A value indicating if the group","is contribution are not. :type is_contribution: bool :param label: The label for the","contribution. :type height: int :param id: The id for the layout node. :type","target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value = value","self.overriden = overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param","for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the","Watermark text for the textbox. :type watermark: str \"\"\" _attribute_map = { 'contribution':","{'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None,","str :param description: :type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField","\"\"\"ProcessModel. :param description: :type description: str :param name: :type name: str :param projects:","{'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type':","{'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type':","behavior_field_id: str :param id: :type id: str :param url: :type url: str \"\"\"","layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the","__init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height",":type description: str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool","color: str :param description: :type description: str :param icon: :type icon: str :param","'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None,","= name self.overriden = overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model):","is_enabled: :type is_enabled: bool :param name: :type name: str \"\"\" _attribute_map = {","contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to",":type url: str \"\"\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id':","{ 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def","'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key':","name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type","super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id = id self.name =","of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height: int","\"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type':","A value indicating if the page should be hidden or not. :type visible:","self).__init__() self.color = color self.hidden = hidden self.id = id self.name = name","= order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior:","'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden',",":type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color:","self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name","self.overridden = overridden self.visible = visible class Page(Model): \"\"\"Page. :param contribution: Contribution for","= height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract:",":param inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type inherits: str","'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None,","{'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type':","class_: :type class_: object :param color: :type color: str :param description: :type description:","the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \"\"\"Control.","def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name =","read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type","url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id = id self.name","the section. :type order: int :param overridden: A value indicating whether this layout",":type color: str :param hidden: :type hidden: bool :param id: :type id: str","file, DO NOT EDIT # Changes may cause incorrect behavior and will be","inputs: A dictionary holding key value pairs for contribution inputs. :type inputs: dict","'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} }","id self.is_identity = is_identity self.name = name self.type = type self.url = url",":class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key':","'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None,","value indicating if the group should be hidden or not. :type visible: bool","is_default: bool :param url: :type url: str \"\"\" _attribute_map = { 'behavior': {'key':","node has been overridden by a child layout. :type overridden: bool :param page_type:","the control. :type metadata: str :param order: :type order: int :param overridden: A","id: :type id: str :param name: :type name: str :param order: :type order:","self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str :param","WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param","id: str :param overridden: A value indicating whether this layout node has been","'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","order: int :param state_category: :type state_category: str :param url: :type url: str \"\"\"","the layout node. :type id: str :param overridden: A value indicating whether this",":type description: str :param icon: :type icon: str :param id: :type id: str","id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name = name","str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type inherits:","is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution","name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name","self.is_contribution = is_contribution self.label = label self.locked = locked self.order = order self.overridden",":param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for","condition_type: str :param field: :type field: str :param value: :type value: str \"\"\"",":type url: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id':","object :param color: :type color: str :param description: :type description: str :param icon:","'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id","list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height:","__init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__()","behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param","'[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages","'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'},","node. :type id: str :param overridden: A value indicating whether this layout node","is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type","'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self,","value: :type value: str \"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'},","extensions: Gets and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param","Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in","{ 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key':","user operations are permitted on this page and the contents of this page","pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls","} def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url",":param field: :type field: str :param value: :type value: str \"\"\" _attribute_map =","A value indicating if the control is readonly. :type read_only: bool :param visible:","textbox. :type watermark: str \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'},","{ 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key':","'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key':","in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO","name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name","bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls',","self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label",":param metadata: Inner text of the control. :type metadata: str :param order: :type","has been overridden by a child layout. :type overridden: bool :param page_type: The","'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}","= url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type",":param visible: A value indicating if the control should be hidden or not.",":param id: The id for the layout node. :type id: str :param overridden:","'{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None):","bool :param label: Label for the field :type label: str :param metadata: Inner","'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name',","WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type","'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def","'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__()","'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} }","fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param","super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls class Group(Model):","'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem',","\"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type':","html controls. :type height: int :param id: The id for the layout node.",":type height: int :param id: The id for the layout node. :type id:","int :param id: The id for the layout node. :type id: str :param","conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type","self.id = id self.inherits = inherits self.name = name self.overriden = overriden self.rank","metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type =","if the control is readonly. :type read_only: bool :param visible: A value indicating",":class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str","\"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type':","'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'},","'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects',","behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param url: :type url:","} def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None):","<work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states: list of :class:`WorkItemStateResultModel","bool :param id: :type id: str :param name: :type name: str :param order:","list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'},","the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions':","'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key':",":type color: str :param description: :type description: str :param icon: :type icon: str",":type version: str \"\"\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default':","= page_type self.sections = sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param description:","<work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name:",":type locked: bool :param order: Order in which the page should appear in","self.contribution = contribution self.controls = controls self.height = height self.id = id self.inherited","contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type id:","is_contribution: bool :param label: The label for the page. :type label: str :param","str :param name: :type name: str :param order: :type order: int :param state_category:","= action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type:","'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key':","'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'},",":param class_: :type class_: object :param color: :type color: str :param description: :type","'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'},","'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description =","'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url',","str :param overridden: A value indicating whether this layout node has been overridden","{'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type':","= { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height':","self.inherits = inherits self.name = name self.overriden = overriden self.rank = rank self.url","deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type':","= is_identity self.name = name self.type = type self.url = url class FieldRuleModel(Model):","inherited: A value indicating whether this layout node has been inherited from a","\"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type':","\"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type':","'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None,","target_field: str :param value: :type value: str \"\"\" _attribute_map = { 'action_type': {'key':","color self.description = description self.fields = fields self.id = id self.inherits = inherits","'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} }","self.behavior = behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param","{ 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id","'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None,","{'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type':","'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id","def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None,","str \"\"\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField',","'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only':","extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs","= is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model):",":type description: str :param name: :type name: str :param projects: :type projects: list","description self.icon = icon self.id = id self.inherits = inherits self.is_disabled = is_disabled","{'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__()","'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def","should appear in the section. :type order: int :param overridden: A value indicating","'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key':","_attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'},","actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions =",":type description: str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str","pages self.system_controls = system_controls class Group(Model): \"\"\"Group. :param contribution: Contribution for the group.","class Control(Model): \"\"\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>`","from :type inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type layout:","height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type","'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None,","'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None,",":type parent_process_type_id: str :param reference_name: :type reference_name: str \"\"\" _attribute_map = { 'description':",":type name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url:","the layout node is contribution are not. :type is_contribution: bool :param label: The","_attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'},","bool \"\"\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id',","id: :type id: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}","Control(Model): \"\"\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param","controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type","'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None):","value indicating whether any user operations are permitted on this page and the","self.action_type = action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param","self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param","= { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url':","overridden self.page_type = page_type self.sections = sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel.","str :param name: :type name: str :param url: :type url: str \"\"\" _attribute_map","overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description =","-------------------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the","'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key':","'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden':","<work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height: int :param id:","'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName',","class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__()","list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should","hidden or not. :type visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution',","The icon for the page. :type page_type: object :param sections: The sections of","is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name","is readonly. :type read_only: bool :param visible: A value indicating if the control","'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key':","visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str :param name: :type name:","'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden',","self.name = name self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id","name: str :param url: :type url: str \"\"\" _attribute_map = { 'description': {'key':","which the page should appear in the layout. :type order: int :param overridden:","page and the contents of this page :type locked: bool :param order: Order",":param order: Order in which the page should appear in the layout. :type","'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution':","__init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default","self).__init__() self.condition_type = condition_type self.field = field self.value = value class Section(Model): \"\"\"Section.",":type id: str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits from","metadata self.order = order self.overridden = overridden self.read_only = read_only self.visible = visible","'[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key':","= visible class Page(Model): \"\"\"Page. :param contribution: Contribution for the page. :type contribution:","= condition_type self.field = field self.value = value class Section(Model): \"\"\"Section. :param groups:","order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type","{'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type':",":param icon: :type icon: str :param id: :type id: str :param inherits: Parent","behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type","be hidden or not. :type visible: bool \"\"\" _attribute_map = { 'contribution': {'key':","the control should be hidden or not. :type visible: bool :param watermark: Watermark","\"\"\"FormLayout. :param extensions: Gets and sets extensions list :type extensions: list of :class:`Extension","label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id","ProjectReference(Model): \"\"\"ProjectReference. :param description: :type description: str :param id: :type id: str :param","self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order","layout. :type order: int :param overridden: A value indicating whether this layout node","is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version:","'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key':","version: str \"\"\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key':","self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract:","friendly_name: str :param id: :type id: str :param is_disabled: :type is_disabled: bool :param","Controls to be put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>`","self.condition_type = condition_type self.field = field self.value = value class Section(Model): \"\"\"Section. :param","'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def",":type show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height':",":type visible: bool \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls':","'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key':","'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description",":param description: :type description: str :param id: :type id: str :param is_identity: :type","'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'},","'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url","= { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height':","= id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type description: str","'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id':","overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden = overridden class",":type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution.","id for the contribution. :type contribution_id: str :param height: The height for the",":param action_type: :type action_type: str :param target_field: :type target_field: str :param value: :type","regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \"\"\"Control. :param contribution: Contribution","is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled =","# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT","inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color","= name self.type = type self.url = url class FieldRuleModel(Model): \"\"\"FieldRuleModel. :param actions:","\"\"\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type':","label self.locked = locked self.order = order self.overridden = overridden self.page_type = page_type","= value class Section(Model): \"\"\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>`","\"\"\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type':","inherits self.is_disabled = is_disabled self.layout = layout self.name = name self.states = states","reference_name class Extension(Model): \"\"\"Extension. :param id: :type id: str \"\"\" _attribute_map = {","has been overridden by a child layout. :type overridden: bool \"\"\" _attribute_map =","object :param url: :type url: str \"\"\" _attribute_map = { 'description': {'key': 'description',","{'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type':","\"\"\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id:","str :param target_field: :type target_field: str :param value: :type value: str \"\"\" _attribute_map","bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \"\"\" _attribute_map","{'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type':","should be hidden or not. :type visible: bool :param watermark: Watermark text for",":class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id: str :param","are not. :type is_contribution: bool :param label: Label for the group. :type label:","read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height =","self.description = description self.id = id self.is_identity = is_identity self.name = name self.type","action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value =","'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key':","{'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions","list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type",":type id: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} }",":type class_: object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool","in the layout. :type order: int :param overridden: A value indicating whether this","str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id',","groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description: :type","{'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type':","'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id',","url: :type url: str \"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'},","'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None,","'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key':","self.control_type = control_type self.height = height self.id = id self.inherited = inherited self.is_contribution","\"\"\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default: bool :param is_enabled:","description: str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param","'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible',","super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name =","{'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type':","'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups =","self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str :param target_field:","self.page_type = page_type self.sections = sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param","'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version',","str \"\"\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault',","is contribution are not. :type is_contribution: bool :param label: Label for the group.",":param color: :type color: str :param description: :type description: str :param fields: :type","the MIT License. See License.txt in the project root for license information. #","The id for the contribution. :type contribution_id: str :param height: The height for","self.id = id self.name = name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param","extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout.","properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects =","inherited self.is_contribution = is_contribution self.label = label self.locked = locked self.order = order","node has been overridden by a child layout. :type overridden: bool \"\"\" _attribute_map","'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None):","{ 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key':",":type url: str \"\"\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden':","'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},","# -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \"\"\"Control. :param contribution: Contribution for","'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None,","{ 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key':","friendly_name: :type friendly_name: str :param id: :type id: str :param is_disabled: :type is_disabled:","id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked = locked",":class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type","value indicating whether this layout node has been overridden by a child layout.","Model class Control(Model): \"\"\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution","section. :type order: int :param overridden: A value indicating whether this layout node","str :param order: :type order: int :param state_category: :type state_category: str :param url:","description: :type description: str :param name: :type name: str :param projects: :type projects:","condition_type self.field = field self.value = value class Section(Model): \"\"\"Section. :param groups: :type","'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__()","'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height',","'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel,","properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type","def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel. :param description:","'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}",":param url: :type url: str \"\"\" _attribute_map = { 'id': {'key': 'id', 'type':","inherited: bool :param is_contribution: A value indicating if the layout node is contribution",":param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The","page. :type label: str :param locked: A value indicating whether any user operations","height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution","} def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field =","watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str :param name: :type name:",":type value: str \"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field':","'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField,","'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'},","layout node has been overridden by a child layout. :type overridden: bool \"\"\"","'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key':","'[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def","'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height',","'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def","'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id',","<work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url: str \"\"\" _attribute_map","str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \"\"\" _attribute_map","page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited =","bool :param watermark: Watermark text for the textbox. :type watermark: str \"\"\" _attribute_map","sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited = inherited","{'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type':","'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} }","field :type label: str :param metadata: Inner text of the control. :type metadata:","{'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None,","color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract =","'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited':","= behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors:","= description self.icon = icon self.id = id self.inherits = inherits self.is_disabled =","= name self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id =","= { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description':","is_contribution: bool :param label: Label for the field :type label: str :param metadata:","The height for the contribution. :type height: int :param inputs: A dictionary holding","parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \"\"\" _attribute_map = {","class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default: bool","'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'},","a child layout. :type overridden: bool :param page_type: The icon for the page.","by a child layout. :type overridden: bool :param read_only: A value indicating if","'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type","'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'},","'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited',","= inherits self.is_disabled = is_disabled self.layout = layout self.name = name self.states =","= { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }","'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None,",":param condition_type: :type condition_type: str :param field: :type field: str :param value: :type","the control is readonly. :type read_only: bool :param visible: A value indicating if","__init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url","id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata","'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def","self.behaviors = behaviors self.class_ = class_ self.color = color self.description = description self.icon","'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key':","by a child layout. :type overridden: bool \"\"\" _attribute_map = { 'groups': {'key':","= is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list","parent layout. This is expected to only be only set by the combiner.","may cause incorrect behavior and will be lost if the code is regenerated.","'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None,","} def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default =","self.id = id self.name = name self.order = order self.state_category = state_category self.url","str \"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field',","'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__()","height self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label",":type action_type: str :param target_field: :type target_field: str :param value: :type value: str","name self.order = order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior.","self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior:","'[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def","def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group,","states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\"","self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class","is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type name:","All rights reserved. # Licensed under the MIT License. See License.txt in the","only set by the combiner. :type inherited: bool :param is_contribution: A value indicating","description self.id = id self.name = name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel.","_attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'},","is_identity: :type is_identity: bool :param name: :type name: str :param type: :type type:","'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName',","self.fields = fields self.id = id self.inherits = inherits self.name = name self.overriden","the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in","icon: str :param id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName","str :param id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName that","self.field = field self.value = value class Section(Model): \"\"\"Section. :param groups: :type groups:","of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should be","'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key':","'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'},","= id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str","the textbox. :type watermark: str \"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type':","'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited':","'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key':","self.value = value class Section(Model): \"\"\"Section. :param groups: :type groups: list of :class:`Group","'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'}","A value indicating if the layout node is contribution are not. :type is_contribution:","'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName',","{'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type':","__init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value","node is contribution are not. :type is_contribution: bool :param label: Label for the","'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__()","__init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel. :param description: :type","= is_disabled self.layout = layout self.name = name self.states = states self.url =","super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id =","the contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map","'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'},","{'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type':","self.description = description self.icon = icon self.id = id self.inherits = inherits self.is_disabled",":param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type","combiner. :type inherited: bool :param is_contribution: A value indicating if the layout node","layout node is contribution are not. :type is_contribution: bool :param label: The label",":class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\" _attribute_map = { 'behaviors': {'key':","reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name","self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id = type_id class","'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,","friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \"\"\"FormLayout.","License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file,","abstract self.color = color self.description = description self.fields = fields self.id = id","Top level tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param","sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page","<work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors',",":param url: :type url: str \"\"\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type':","'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None,","self).__init__() self.description = description self.id = id self.name = name self.url = url","A value indicating if the layout node is contribution or not. :type is_contribution:","'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden',","{'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type':","_attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},","def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color =",":type page_type: object :param sections: The sections of the page. :type sections: list","'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order',","overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type","name: :type name: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},","action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type","has been overridden by a child layout. :type overridden: bool :param read_only: A","is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url = url","and the contents of this page :type locked: bool :param order: Order in","= groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel. :param description:","\"\"\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type':","text of the control. :type metadata: str :param order: :type order: int :param","id: The id for the layout node. :type id: str :param inherited: A","url class WorkItemBehaviorReference(Model): \"\"\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url:","ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default: bool :param",":param order: Order in which the group should appear in the section. :type",":param url: :type url: str \"\"\" _attribute_map = { 'abstract': {'key': 'abstract', 'type':","in which the page should appear in the layout. :type order: int :param","Id/Internal ReferenceName that it inherits from :type inherits: str :param is_disabled: :type is_disabled:","contents of this page :type locked: bool :param order: Order in which the","'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key':","this page :type locked: bool :param order: Order in which the page should","a parent layout. This is expected to only be only set by the","inherits self.name = name self.overriden = overriden self.rank = rank self.url = url",":param id: The id for the layout node. :type id: str :param inherited:","str :param icon: :type icon: str :param id: :type id: str :param inherits:","overridden: bool :param read_only: A value indicating if the control is readonly. :type","system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map = { 'extensions': {'key': 'extensions', 'type':","class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version","self.rank = rank self.url = url class WorkItemBehaviorField(Model): \"\"\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id:",":param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \"\"\" _attribute_map =","overridden self.visible = visible class Page(Model): \"\"\"Page. :param contribution: Contribution for the page.","self.label = label self.metadata = metadata self.order = order self.overridden = overridden self.read_only","'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel.","'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__()","NOT EDIT # Changes may cause incorrect behavior and will be lost if","'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields':","self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls class Group(Model): \"\"\"Group.","WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool","{'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None,","height: The height for the contribution. :type height: int :param id: The id","layout. :type overridden: bool :param page_type: The icon for the page. :type page_type:","str :param hidden: :type hidden: bool :param id: :type id: str :param name:","License. See License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- #","{'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type':","Label for the field :type label: str :param metadata: Inner text of the","_attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'},","-------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \"\"\"Control. :param contribution: Contribution for the","self.id = id self.url = url class WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color:","icon for the page. :type page_type: object :param sections: The sections of the",":type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id:",":type id: str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool","{'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None,",":param type_id: :type type_id: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type':","show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key':",":type is_contribution: bool :param label: The label for the page. :type label: str","holding key value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A","is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled","{'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None,","contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id","} def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_","or not. :type is_contribution: bool :param label: Label for the field :type label:","name: :type name: str :param url: :type url: str \"\"\" _attribute_map = {","= name self.order = order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model):","'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs',",":param behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param url: :type","} def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None):","'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'},","= watermark class CreateProcessModel(Model): \"\"\"CreateProcessModel. :param description: :type description: str :param name: :type","= overridden self.page_type = page_type self.sections = sections self.visible = visible class ProcessModel(Model):","if the contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool \"\"\"","'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible',","in the section. :type order: int :param overridden: A value indicating whether this","overridden by a child layout. :type overridden: bool :param page_type: The icon for","self.description = description self.name = name self.projects = projects self.properties = properties self.reference_name","'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} }","Height of the control, for html controls. :type height: int :param id: The","bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param","} def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel. :param","if the page should be hidden or not. :type visible: bool \"\"\" _attribute_map","behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type",":param name: :type name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>`",":type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str","\"\"\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type':","tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers","indicating if the group should be hidden or not. :type visible: bool \"\"\"","is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled","expected to only be only set by the combiner. :type inherited: bool :param","self).__init__() self.contribution = contribution self.control_type = control_type self.height = height self.id = id","color: :type color: str :param hidden: :type hidden: bool :param id: :type id:","'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} }","on deleted workItem. :type show_on_deleted_work_item: bool \"\"\" _attribute_map = { 'contribution_id': {'key': 'contributionId',","'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields',","'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'}","hidden: :type hidden: bool :param id: :type id: str :param name: :type name:","'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None,","class RuleConditionModel(Model): \"\"\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field: str","{'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None,","str :param url: :type url: str \"\"\" _attribute_map = { 'color': {'key': 'color',",":param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states:","description: str :param id: :type id: str :param name: :type name: str :param","'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'},","= show_on_deleted_work_item class WorkItemBehavior(Model): \"\"\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type","'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None):","__init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id","= url class WorkItemTypeModel(Model): \"\"\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>`","= name self.url = url class RuleActionModel(Model): \"\"\"RuleActionModel. :param action_type: :type action_type: str","super(Extension, self).__init__() self.id = id class FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str","the layout node. :type id: str :param inherited: A value indicating whether this","list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color:",":param system_controls: Headers controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>`","abstract: bool :param color: :type color: str :param description: :type description: str :param","self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order","parent_process_type_id self.reference_name = reference_name class Extension(Model): \"\"\"Extension. :param id: :type id: str \"\"\"","of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name:","{'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type':","super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item =","height: Height of the control, for html controls. :type height: int :param id:","'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None):","'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section,","class WorkItemTypeBehavior(Model): \"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default:","{'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None,",":type name: str :param order: :type order: int :param state_category: :type state_category: str","str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault',","'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'},","{'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type':","color: :type color: str :param description: :type description: str :param icon: :type icon:","\"\"\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param","page :type locked: bool :param order: Order in which the page should appear","the group should appear in the section. :type order: int :param overridden: A","\"\"\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url: str \"\"\" _attribute_map","is contribution or not. :type is_contribution: bool :param label: Label for the field",":param watermark: Watermark text for the textbox. :type watermark: str \"\"\" _attribute_map =","'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name':","hidden or not. :type visible: bool :param watermark: Watermark text for the textbox.","self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked","__init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None):",":type field: str :param value: :type value: str \"\"\" _attribute_map = { 'condition_type':","reference_name self.type_id = type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object :param","'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key':","str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \"\"\" _attribute_map","'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None,","{ 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key':","is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id:",":param visible: A value indicating if the page should be hidden or not.","'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key':","{'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None,","value indicating if the contribution should be show on deleted workItem. :type show_on_deleted_work_item:","{'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type':","{'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None,","'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id',","str :param id: :type id: str :param url: :type url: str \"\"\" _attribute_map","self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name = name class","behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type","'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id':","list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls:","'[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key':","= id self.is_identity = is_identity self.name = name self.type = type self.url =","self.name = name self.order = order self.state_category = state_category self.url = url class","{ 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key':","height: The height for the contribution. :type height: int :param inputs: A dictionary","controls. :type height: int :param id: The id for the layout node. :type","url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url class","contribution_id: The id for the contribution. :type contribution_id: str :param height: The height","{ 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key':","\"\"\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id","'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'}","self.name = name self.overriden = overriden self.rank = rank self.url = url class","id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_","indicating whether this layout node has been overridden by a child layout. :type","'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None,","id: The id for the layout node. :type id: str :param overridden: A","A dictionary holding key value pairs for contribution inputs. :type inputs: dict :param","the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for","node has been inherited from a parent layout. This is expected to only","'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled':","read_only: bool :param visible: A value indicating if the control should be hidden","'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name':","Licensed under the MIT License. See License.txt in the project root for license",":param page_type: The icon for the page. :type page_type: object :param sections: The",":param value: :type value: str \"\"\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type':","Headers controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \"\"\" _attribute_map","not. :type is_contribution: bool :param label: Label for the group. :type label: str",":param height: The height for the contribution. :type height: int :param id: The",":type class_: object :param color: :type color: str :param description: :type description: str","'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} }","'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id':","order self.overridden = overridden self.visible = visible class Page(Model): \"\"\"Page. :param contribution: Contribution","{'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None,","class FormLayout(Model): \"\"\"FormLayout. :param extensions: Gets and sets extensions list :type extensions: list","Extension(Model): \"\"\"Extension. :param id: :type id: str \"\"\" _attribute_map = { 'id': {'key':","{'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None,","value indicating if the control should be hidden or not. :type visible: bool",":type inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution should be","__init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls","type_id: str \"\"\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key':","parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \"\"\" _attribute_map = {","of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \"\"\" _attribute_map = { 'behaviors':","{'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type':","'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior,","self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id = id","height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs =","action_type: :type action_type: str :param target_field: :type target_field: str :param value: :type value:","= order self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark =","field self.value = value class Section(Model): \"\"\"Section. :param groups: :type groups: list of","= sections self.visible = visible class ProcessModel(Model): \"\"\"ProcessModel. :param description: :type description: str","show_on_deleted_work_item: A value indicating if the contribution should be show on deleted workItem.","'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel,","'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'},","self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name = name self.states","'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden':","of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type pages:","'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'},","'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'},","'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description","'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description =","rank: :type rank: int :param url: :type url: str \"\"\" _attribute_map = {","'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description',","the field :type label: str :param metadata: Inner text of the control. :type","self.icon = icon self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout","\"\"\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden: bool :param id:","dict :param show_on_deleted_work_item: A value indicating if the contribution should be show on","self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark = watermark class","str :param height: The height for the contribution. :type height: int :param inputs:","height: int :param id: The id for the layout node. :type id: str","watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height = height self.id","<work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group. :type controls: list","'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'},","{'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type':","'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name':",":type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout.","} def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None,","WorkItemStateResultModel(Model): \"\"\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden: bool :param","bool :param label: The label for the page. :type label: str :param locked:","name: :type name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param","__init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id",":param name: :type name: str :param url: :type url: str \"\"\" _attribute_map =","'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key':","url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color self.description",":class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url: str \"\"\"","A value indicating if the group should be hidden or not. :type visible:","'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'},","is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id","self).__init__() self.groups = groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \"\"\"UpdateProcessModel.","__init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url",":type is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type name: str","self.id = id class FieldModel(Model): \"\"\"FieldModel. :param description: :type description: str :param id:","is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \"\"\"ProjectReference.","order self.overridden = overridden self.page_type = page_type self.sections = sections self.visible = visible","id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color =","type_id class ProcessProperties(Model): \"\"\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default:","{'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None,","for the textbox. :type watermark: str \"\"\" _attribute_map = { 'contribution': {'key': 'contribution',","Type of the control. :type control_type: str :param height: Height of the control,","class_: object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param","readonly. :type read_only: bool :param visible: A value indicating if the control should","def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id","is_contribution self.label = label self.metadata = metadata self.order = order self.overridden = overridden"],"string":"[\n \"'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None,\",\n \"inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls =\",\n \"state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id = id\",\n \"'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key':\",\n \"name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity =\",\n \"'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id\",\n \"Gets and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages:\",\n \"{'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type':\",\n \"class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_:\",\n \"layout node is contribution are not. :type is_contribution: bool :param label: Label for\",\n \"'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None,\",\n \"'[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key':\",\n \"self.groups = groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param\",\n \"'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None,\",\n \"for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if the\",\n \"{'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type':\",\n \"self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions list\",\n \":param description: :type description: str :param is_default: :type is_default: bool :param is_enabled: :type\",\n \"'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key':\",\n \"{'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type':\",\n \"description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension.\",\n \"{'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None,\",\n \"str :param locked: A value indicating whether any user operations are permitted on\",\n \"\\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color: str :param description:\",\n \"overridden by a child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups':\",\n \"'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__()\",\n \"field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value = value\",\n \"'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url',\",\n \"of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type id:\",\n \"{'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type':\",\n \"= overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the\",\n \"'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key':\",\n \"'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory',\",\n \"self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system\",\n \"cause incorrect behavior and will be lost if the code is regenerated. #\",\n \"str :param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description',\",\n \"'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'},\",\n \"'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key':\",\n \"the group. :type label: str :param order: Order in which the group should\",\n \"\\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type':\",\n \"} def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description =\",\n \"self).__init__() self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution\",\n \"= inherited self.is_contribution = is_contribution self.label = label self.locked = locked self.order =\",\n \"id for the layout node. :type id: str :param overridden: A value indicating\",\n \"self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param hidden:\",\n \"name: :type name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param\",\n \"'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible',\",\n \"is_disabled: bool :param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key':\",\n \"= description self.name = name self.projects = projects self.properties = properties self.reference_name =\",\n \":param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions', 'type':\",\n \"} def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id =\",\n \"self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str :param name:\",\n \"self.extensions = extensions self.pages = pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param\",\n \"id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order = order\",\n \":param is_enabled: :type is_enabled: bool :param name: :type name: str \\\"\\\"\\\" _attribute_map =\",\n \"bool :param order: Order in which the page should appear in the layout.\",\n \"license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may\",\n \":type overriden: bool :param rank: :type rank: int :param url: :type url: str\",\n \"id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'id': {'key':\",\n \"str :param field: :type field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key':\",\n \"node has been overridden by a child layout. :type overridden: bool :param visible:\",\n \"'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key':\",\n \"version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id\",\n \"order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id =\",\n \"label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height\",\n \"the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of\",\n \"self.locked = locked self.order = order self.overridden = overridden self.page_type = page_type self.sections\",\n \":type is_default: bool :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior':\",\n \"state_category: :type state_category: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \"order: int :param overridden: A value indicating whether this layout node has been\",\n \"'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'}\",\n \"name: str :param overriden: :type overriden: bool :param rank: :type rank: int :param\",\n \":type contribution_id: str :param height: The height for the contribution. :type height: int\",\n \"extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls =\",\n \"fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color\",\n \"{'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type':\",\n \":param pages: Top level tabs of the layout. :type pages: list of :class:`Page\",\n \"\\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type':\",\n \"'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon':\",\n \"'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None,\",\n \"{'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type':\",\n \"url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param\",\n \"'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits':\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'},\",\n \"str :param is_identity: :type is_identity: bool :param name: :type name: str :param type:\",\n \":param overriden: :type overriden: bool :param rank: :type rank: int :param url: :type\",\n \"class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\" _attribute_map = { 'id':\",\n \"description self.id = id self.is_identity = is_identity self.name = name self.type = type\",\n \"'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'},\",\n \":param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id:\",\n \"self.id = id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param\",\n \"contribution_id: str :param height: The height for the contribution. :type height: int :param\",\n \"'[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None,\",\n \"class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field: str\",\n \"'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key':\",\n \"self.is_default = is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param\",\n \"'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system':\",\n \"layout. :type overridden: bool :param visible: A value indicating if the group should\",\n \"self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors:\",\n \"id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name =\",\n \"description: str :param icon: :type icon: str :param id: :type id: str :param\",\n \"'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name',\",\n \":param color: :type color: str :param description: :type description: str :param icon: :type\",\n \"= behaviors self.class_ = class_ self.color = color self.description = description self.icon =\",\n \"'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None):\",\n \"list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits:\",\n \"= is_contribution self.label = label self.locked = locked self.order = order self.overridden =\",\n \"indicating whether any user operations are permitted on this page and the contents\",\n \"self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description:\",\n \"class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default\",\n \"workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'},\",\n \"= inherits self.name = name self.overriden = overriden self.rank = rank self.url =\",\n \"'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key':\",\n \"'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'},\",\n \":param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url:\",\n \"locked: A value indicating whether any user operations are permitted on this page\",\n \"{'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type':\",\n \"node has been overridden by a child layout. :type overridden: bool :param read_only:\",\n \"is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions\",\n \"page_type: The icon for the page. :type page_type: object :param sections: The sections\",\n \"'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'}\",\n \"str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id',\",\n \"} def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description =\",\n \"id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param\",\n \"self.is_contribution = is_contribution self.label = label self.order = order self.overridden = overridden self.visible\",\n \":param id: :type id: str :param name: :type name: str :param order: :type\",\n \"Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param\",\n \"str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id',\",\n \"str :param inherited: A value indicating whether this layout node has been inherited\",\n \"# Changes may cause incorrect behavior and will be lost if the code\",\n \"{'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type':\",\n \"{'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type':\",\n \"inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs\",\n \":param is_contribution: A value indicating if the layout node is contribution or not.\",\n \"description: str :param id: :type id: str :param is_identity: :type is_identity: bool :param\",\n \"self).__init__() self.contribution = contribution self.controls = controls self.height = height self.id = id\",\n \"id for the layout node. :type id: str :param inherited: A value indicating\",\n \":param order: :type order: int :param state_category: :type state_category: str :param url: :type\",\n \"'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order',\",\n \"'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None,\",\n \"self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference.\",\n \"<work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id: str :param is_disabled:\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'},\",\n \"or not. :type visible: bool :param watermark: Watermark text for the textbox. :type\",\n \":param id: :type id: str :param is_identity: :type is_identity: bool :param name: :type\",\n \"{'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type':\",\n \"'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'},\",\n \"value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param\",\n \"self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system class\",\n \"'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel,\",\n \":type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str\",\n \"_attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'},\",\n \":type is_contribution: bool :param label: Label for the field :type label: str :param\",\n \"= description self.id = id self.is_identity = is_identity self.name = name self.type =\",\n \"{'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type':\",\n \"} def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field =\",\n \":param inputs: A dictionary holding key value pairs for contribution inputs. :type inputs:\",\n \"for the page. :type page_type: object :param sections: The sections of the page.\",\n \":type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the\",\n \"list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param\",\n \"project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT\",\n \"= behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id:\",\n \"label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type\",\n \"{'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type':\",\n \"{'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None,\",\n \"= hidden self.id = id self.name = name self.order = order self.state_category =\",\n \"'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param\",\n \"A value indicating whether any user operations are permitted on this page and\",\n \"'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"= url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type\",\n \":type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout\",\n \"{'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None,\",\n \"of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color: str\",\n \"'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'},\",\n \"id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden = overridden\",\n \"'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name',\",\n \"= height self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label =\",\n \"abstract: :type abstract: bool :param color: :type color: str :param description: :type description:\",\n \":param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str\",\n \"{ 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key':\",\n \"self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type\",\n \"controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map =\",\n \"name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param\",\n \"overridden: bool :param page_type: The icon for the page. :type page_type: object :param\",\n \"__init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page,\",\n \"'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior\",\n \"EDIT # Changes may cause incorrect behavior and will be lost if the\",\n \"_attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension,\",\n \"page. :type page_type: object :param sections: The sections of the page. :type sections:\",\n \"the contribution. :type height: int :param inputs: A dictionary holding key value pairs\",\n \"'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item':\",\n \"name: :type name: str :param overriden: :type overriden: bool :param rank: :type rank:\",\n \"layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states: list\",\n \"_attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'},\",\n \":param visible: A value indicating if the group should be hidden or not.\",\n \"= overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id:\",\n \"} def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name\",\n \"self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order = order self.overridden\",\n \"int :param overridden: A value indicating whether this layout node has been overridden\",\n \":param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type\",\n \"description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name =\",\n \"layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key':\",\n \"and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top\",\n \"'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ =\",\n \"'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key':\",\n \":type target_field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'action_type':\",\n \"id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution\",\n \"'[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key':\",\n \"sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str :param\",\n \"int :param inputs: A dictionary holding key value pairs for contribution inputs. :type\",\n \"'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key':\",\n \"name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name:\",\n \"'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None,\",\n \"{'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type':\",\n \"layout. This is expected to only be only set by the combiner. :type\",\n \"= properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_:\",\n \"'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None,\",\n \"'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key':\",\n \"{'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type':\",\n \"ReferenceName that it inherits from :type inherits: str :param is_disabled: :type is_disabled: bool\",\n \"# Generated file, DO NOT EDIT # Changes may cause incorrect behavior and\",\n \"control is readonly. :type read_only: bool :param visible: A value indicating if the\",\n \":param extensions: Gets and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>`\",\n \"order: Order in which the page should appear in the layout. :type order:\",\n \"label: str :param metadata: Inner text of the control. :type metadata: str :param\",\n \"RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field: str :param\",\n \"reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},\",\n \"The height for the contribution. :type height: int :param id: The id for\",\n \":type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id:\",\n \"'[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key':\",\n \"the contribution. :type height: int :param id: The id for the layout node.\",\n \"{'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type':\",\n \"'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key':\",\n \"order: Order in which the group should appear in the section. :type order:\",\n \"The sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible:\",\n \"self.is_identity = is_identity self.name = name self.type = type self.url = url class\",\n \":type name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties:\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior', 'type':\",\n \"'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order',\",\n \"self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description:\",\n \"WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id: str :param\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None):\",\n \"self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param is_default:\",\n \"'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def\",\n \"{'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type':\",\n \"fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type\",\n \"class_ self.color = color self.description = description self.icon = icon self.id = id\",\n \"is_default: :type is_default: bool :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \":param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType', 'type':\",\n \"self.is_disabled = is_disabled self.layout = layout self.name = name self.states = states self.url\",\n \"super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color:\",\n \"is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_\",\n \"'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id',\",\n \"the page should appear in the layout. :type order: int :param overridden: A\",\n \":param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map =\",\n \"self.order = order self.overridden = overridden self.page_type = page_type self.sections = sections self.visible\",\n \"{'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None,\",\n \"def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height =\",\n \"self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param\",\n \"color self.hidden = hidden self.id = id self.name = name self.order = order\",\n \":param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type\",\n \"} def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages =\",\n \"lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class\",\n \"for the layout node. :type id: str :param inherited: A value indicating whether\",\n \"'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key':\",\n \"'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"self.behavior_field_id = behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param\",\n \"icon: :type icon: str :param id: :type id: str :param inherits: Parent WIT\",\n \"'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None,\",\n \"class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>`\",\n \":type name: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description':\",\n \"'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label':\",\n \"= rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str\",\n \"= target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str\",\n \"{'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None,\",\n \"'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value',\",\n \"id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden\",\n \"{ 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key':\",\n \"{ 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key':\",\n \"self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param\",\n \"layout node. :type id: str :param inherited: A value indicating whether this layout\",\n \"_attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'},\",\n \"groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node.\",\n \"is_identity: bool :param name: :type name: str :param type: :type type: object :param\",\n \"= is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets\",\n \"'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None,\",\n \"page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if\",\n \"'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url':\",\n \"'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'}\",\n \"{'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type':\",\n \":type name: str :param overriden: :type overriden: bool :param rank: :type rank: int\",\n \"'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order':\",\n \"self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id:\",\n \":type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"{'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type':\",\n \":type overridden: bool :param read_only: A value indicating if the control is readonly.\",\n \"'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key':\",\n \"the layout. :type order: int :param overridden: A value indicating whether this layout\",\n \"which the group should appear in the section. :type order: int :param overridden:\",\n \"action_type: str :param target_field: :type target_field: str :param value: :type value: str \\\"\\\"\\\"\",\n \"name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id =\",\n \"self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class\",\n \":type condition_type: str :param field: :type field: str :param value: :type value: str\",\n \"WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url: str \\\"\\\"\\\"\",\n \"color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors\",\n \":type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states:\",\n \":type watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type':\",\n \"__init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None,\",\n \"'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked':\",\n \"= abstract self.color = color self.description = description self.fields = fields self.id =\",\n \"class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default: bool\",\n \"{ 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key':\",\n \"'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None,\",\n \"'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'},\",\n \"'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} }\",\n \"watermark: Watermark text for the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map = {\",\n \"be only set by the combiner. :type inherited: bool :param is_contribution: A value\",\n \"'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id class\",\n \"layout. :type overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'},\",\n \"<work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type id: str :param\",\n \"See License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated\",\n \"'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}\",\n \"'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None,\",\n \"description: str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param\",\n \"url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id:\",\n \"\\\"\\\"\\\"FieldModel. :param description: :type description: str :param id: :type id: str :param is_identity:\",\n \"name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name = name\",\n \"str :param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description',\",\n \"'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None):\",\n \"the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type\",\n \"sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A\",\n \"metadata: str :param order: :type order: int :param overridden: A value indicating whether\",\n \"= contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label =\",\n \"bool :param is_enabled: :type is_enabled: bool :param name: :type name: str \\\"\\\"\\\" _attribute_map\",\n \":param class_: :type class_: object :param is_default: :type is_default: bool :param is_enabled: :type\",\n \"'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'},\",\n \"'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'},\",\n \"<work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden: bool :param rank:\",\n \"hidden: bool :param id: :type id: str :param name: :type name: str :param\",\n \"group. :type label: str :param order: Order in which the group should appear\",\n \"{'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None,\",\n \"'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description':\",\n \"= { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value':\",\n \"{'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type':\",\n \"dictionary holding key value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item:\",\n \"of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value\",\n \":type color: str :param description: :type description: str :param fields: :type fields: list\",\n \"{'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type':\",\n \"= { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden':\",\n \"= friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model):\",\n \"self).__init__() self.description = description self.name = name self.projects = projects self.properties = properties\",\n \":param read_only: A value indicating if the control is readonly. :type read_only: bool\",\n \"actions self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled\",\n \"url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name = name self.url\",\n \"the layout node is contribution or not. :type is_contribution: bool :param label: Label\",\n \":type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str\",\n \":param description: :type description: str :param id: :type id: str :param name: :type\",\n \"= overridden self.read_only = read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model):\",\n \"str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def __init__(self,\",\n \"msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the control. :type\",\n \"{'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__()\",\n \"'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity',\",\n \"{'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type':\",\n \"value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating\",\n \":param inherited: A value indicating whether this layout node has been inherited from\",\n \"def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description\",\n \"= reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\" _attribute_map =\",\n \"is_disabled self.layout = layout self.name = name self.states = states self.url = url\",\n \":type description: str :param id: :type id: str :param name: :type name: str\",\n \"label: Label for the field :type label: str :param metadata: Inner text of\",\n \"str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name:\",\n \"bool :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior',\",\n \"{'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None,\",\n \"is_identity self.name = name self.type = type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel.\",\n \"'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'},\",\n \"class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color: str\",\n \"'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id':\",\n \"icon self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout\",\n \"'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name':\",\n \"'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType',\",\n \"from a parent layout. This is expected to only be only set by\",\n \"'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name':\",\n \"= read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description:\",\n \"'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None,\",\n \"{'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type':\",\n \"root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT #\",\n \"= type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list\",\n \"id: str :param name: :type name: str :param url: :type url: str \\\"\\\"\\\"\",\n \"self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_:\",\n \"class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str :param id: :type id: str\",\n \"type: object :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key':\",\n \"self.order = order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param\",\n \"contribution are not. :type is_contribution: bool :param label: The label for the page.\",\n \":param description: :type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>`\",\n \"} def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color\",\n \"= id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order =\",\n \"'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self,\",\n \"rank: int :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key':\",\n \"order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type\",\n \"field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key':\",\n \"{'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type':\",\n \"str :param version: :type version: str \\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class',\",\n \"by a child layout. :type overridden: bool :param visible: A value indicating if\",\n \"'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self,\",\n \":type value: str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field':\",\n \"bool :param is_contribution: A value indicating if the layout node is contribution or\",\n \"id: :type id: str :param name: :type name: str :param url: :type url:\",\n \"{'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None,\",\n \"'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id self.name\",\n \"'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections',\",\n \"} def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id\",\n \"def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default\",\n \"bool :param rank: :type rank: int :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \":type id: str :param name: :type name: str :param order: :type order: int\",\n \"of the control, for html controls. :type height: int :param id: The id\",\n \"contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs\",\n \"Changes may cause incorrect behavior and will be lost if the code is\",\n \"the control, for html controls. :type height: int :param id: The id for\",\n \"\\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field: str :param value:\",\n \":param version: :type version: str \\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class', 'type':\",\n \"= visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str\",\n \"str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url:\",\n \"class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id: str\",\n \"if the layout node is contribution or not. :type is_contribution: bool :param label:\",\n \":type id: str :param is_identity: :type is_identity: bool :param name: :type name: str\",\n \"control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type:\",\n \":param contribution_id: The id for the contribution. :type contribution_id: str :param height: The\",\n \"'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None,\",\n \"'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description\",\n \"'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'},\",\n \"name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description\",\n \"def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior,\",\n \"'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None,\",\n \"_attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'},\",\n \"'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None,\",\n \"= visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str :param name: :type\",\n \"= { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value':\",\n \"str :param name: :type name: str :param projects: :type projects: list of :class:`ProjectReference\",\n \"{'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type':\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id\",\n \":param description: :type description: str :param icon: :type icon: str :param id: :type\",\n \"= { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color':\",\n \"object :param sections: The sections of the page. :type sections: list of :class:`Section\",\n \"description: :type description: str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id:\",\n \":param rank: :type rank: int :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls\",\n \":param name: :type name: str :param order: :type order: int :param state_category: :type\",\n \"{'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None):\",\n \"'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel,\",\n \"Inner text of the control. :type metadata: str :param order: :type order: int\",\n \"hidden self.id = id self.name = name self.order = order self.state_category = state_category\",\n \":param friendly_name: :type friendly_name: str :param id: :type id: str :param is_disabled: :type\",\n \"value indicating if the control is readonly. :type read_only: bool :param visible: A\",\n \"self.sections = sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description:\",\n \"self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param name:\",\n \":param type: :type type: object :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"reference_name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key':\",\n \"label: The label for the page. :type label: str :param locked: A value\",\n \"bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height',\",\n \"= actions self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled =\",\n \"description: :type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param\",\n \"'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits',\",\n \"'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description\",\n \"= projects self.properties = properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model):\",\n \"def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id\",\n \"page should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map = {\",\n \"'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'},\",\n \"= version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str :param id: :type\",\n \"self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param color:\",\n \"'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__()\",\n \"'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None,\",\n \"def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id =\",\n \"is_contribution: bool :param label: Label for the group. :type label: str :param order:\",\n \"description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type\",\n \"is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map = {\",\n \"inherited self.is_contribution = is_contribution self.label = label self.order = order self.overridden = overridden\",\n \":param color: :type color: str :param hidden: :type hidden: bool :param id: :type\",\n \"= { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name':\",\n \"'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden',\",\n \":class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id: str \\\"\\\"\\\"\",\n \"type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects = projects self.properties\",\n \"'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url',\",\n \"abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract\",\n \"id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key':\",\n \"= contribution self.controls = controls self.height = height self.id = id self.inherited =\",\n \"properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type\",\n \"# -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause incorrect\",\n \"name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id\",\n \"= label self.order = order self.overridden = overridden self.visible = visible class Page(Model):\",\n \"bool :param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions',\",\n \"class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url: str\",\n \"str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class',\",\n \"child layout. :type overridden: bool :param read_only: A value indicating if the control\",\n \":param height: The height for the contribution. :type height: int :param inputs: A\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None,\",\n \"list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \":type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param\",\n \"self.id = id self.is_identity = is_identity self.name = name self.type = type self.url\",\n \"{'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type':\",\n \"is expected to only be only set by the combiner. :type inherited: bool\",\n \"rights reserved. # Licensed under the MIT License. See License.txt in the project\",\n \"<work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map\",\n \":param label: Label for the group. :type label: str :param order: Order in\",\n \"self.label = label self.order = order self.overridden = overridden self.visible = visible class\",\n \"'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution':\",\n \"{'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type':\",\n \"{ 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key':\",\n \"{'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None,\",\n \"'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states':\",\n \":type reference_name: str :param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map = { 'description':\",\n \"= is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions list :type\",\n \"show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item\",\n \"name self.overriden = overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField.\",\n \"overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height = height\",\n \"projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>`\",\n \":class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden: bool :param\",\n \"layout node is contribution or not. :type is_contribution: bool :param label: Label for\",\n \"{'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type':\",\n \"'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description\",\n \"ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str :param name: :type name: str :param\",\n \"class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id:\",\n \"str :param height: Height of the control, for html controls. :type height: int\",\n \"'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url',\",\n \"bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version:\",\n \"Generated file, DO NOT EDIT # Changes may cause incorrect behavior and will\",\n \"contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution\",\n \"'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"whether any user operations are permitted on this page and the contents of\",\n \"value indicating if the page should be hidden or not. :type visible: bool\",\n \"url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity = is_identity self.name\",\n \"'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'}\",\n \"class_: :type class_: object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled:\",\n \"'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} }\",\n \"'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order',\",\n \"is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type\",\n \"str :param description: :type description: str :param icon: :type icon: str :param id:\",\n \"the contribution. :type contribution_id: str :param height: The height for the contribution. :type\",\n \"'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} }\",\n \"{'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type':\",\n \"if the layout node is contribution are not. :type is_contribution: bool :param label:\",\n \"id: str :param inherited: A value indicating whether this layout node has been\",\n \"= is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for\",\n \"str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color',\",\n \"'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self,\",\n \"self.color = color self.description = description self.icon = icon self.id = id self.inherits\",\n \"node is contribution are not. :type is_contribution: bool :param label: The label for\",\n \"= { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects':\",\n \"def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages\",\n \"str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description',\",\n \"'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None,\",\n \"id: :type id: str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system:\",\n \":type read_only: bool :param visible: A value indicating if the control should be\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color':\",\n \"\\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param url:\",\n \":type is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions':\",\n \"text for the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key':\",\n \"appear in the layout. :type order: int :param overridden: A value indicating whether\",\n \"self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param is_default:\",\n \"'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel,\",\n \"{ 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key':\",\n \"'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def\",\n \"The label for the page. :type label: str :param locked: A value indicating\",\n \"description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled\",\n \"'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'},\",\n \"'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key':\",\n \"'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key':\",\n \":class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states: list of\",\n \"description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors =\",\n \"'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None,\",\n \"'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} }\",\n \"'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'}\",\n \":param id: :type id: str :param is_disabled: :type is_disabled: bool :param is_system: :type\",\n \"self.type = type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions:\",\n \"CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param name: :type name: str :param\",\n \"visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height = height self.id\",\n \"contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__()\",\n \":param label: Label for the field :type label: str :param metadata: Inner text\",\n \"projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name:\",\n \"locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id =\",\n \"= state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference\",\n \"str :param id: :type id: str :param is_identity: :type is_identity: bool :param name:\",\n \"'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self,\",\n \"= control_type self.height = height self.id = id self.inherited = inherited self.is_contribution =\",\n \"} def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default\",\n \"be put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height:\",\n \"'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None,\",\n \"'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id\",\n \"the group should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map =\",\n \"'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None,\",\n \"id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url\",\n \"visible: A value indicating if the group should be hidden or not. :type\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None,\",\n \"color self.description = description self.icon = icon self.id = id self.inherits = inherits\",\n \"'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def\",\n \"'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior =\",\n \"self).__init__() self.behavior = behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel.\",\n \"controls self.height = height self.id = id self.inherited = inherited self.is_contribution = is_contribution\",\n \":type is_disabled: bool :param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions':\",\n \"Order in which the group should appear in the section. :type order: int\",\n \":param sections: The sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>`\",\n \"visible: A value indicating if the page should be hidden or not. :type\",\n \"name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id:\",\n \"str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name',\",\n \"Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be\",\n \":param show_on_deleted_work_item: A value indicating if the contribution should be show on deleted\",\n \":param id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName that it\",\n \"to be put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param\",\n \"level tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls:\",\n \":param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden:\",\n \"'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key':\",\n \"self.hidden = hidden self.id = id self.name = name self.order = order self.state_category\",\n \":type is_identity: bool :param name: :type name: str :param type: :type type: object\",\n \"target_field: :type target_field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map = {\",\n \"inherited from a parent layout. This is expected to only be only set\",\n \"'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key':\",\n \"description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id =\",\n \"if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model):\",\n \"{ 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key':\",\n \":type visible: bool :param watermark: Watermark text for the textbox. :type watermark: str\",\n \"'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key':\",\n \"= id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions:\",\n \":param height: Height of the control, for html controls. :type height: int :param\",\n \"id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets\",\n \"self.color = color self.description = description self.fields = fields self.id = id self.inherits\",\n \"'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None,\",\n \"id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution\",\n \"behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url =\",\n \"= reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object\",\n \"target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param\",\n \"not. :type visible: bool :param watermark: Watermark text for the textbox. :type watermark:\",\n \"is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for the\",\n \"'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url':\",\n \"id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str\",\n \"str :param id: :type id: str :param name: :type name: str :param url:\",\n \"'[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None,\",\n \"= label self.locked = locked self.order = order self.overridden = overridden self.page_type =\",\n \"self.pages = pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for\",\n \"'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}\",\n \"\\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type':\",\n \"type: :type type: object :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \":type height: int :param inputs: A dictionary holding key value pairs for contribution\",\n \"= id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str\",\n \"{'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type':\",\n \"the page. :type label: str :param locked: A value indicating whether any user\",\n \":param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name:\",\n \"'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id',\",\n \"is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls\",\n \"int :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract',\",\n \"id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name =\",\n \"'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__()\",\n \"for the group. :type label: str :param order: Order in which the group\",\n \"\\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type':\",\n \"indicating if the control is readonly. :type read_only: bool :param visible: A value\",\n \"\\\"\\\"\\\"ProjectReference. :param description: :type description: str :param id: :type id: str :param name:\",\n \"'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None,\",\n \"value: str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key':\",\n \"'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self,\",\n \"= inherited self.is_contribution = is_contribution self.label = label self.order = order self.overridden =\",\n \"id: :type id: str :param is_identity: :type is_identity: bool :param name: :type name:\",\n \"list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of\",\n \"'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata',\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type':\",\n \"UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default: bool :param\",\n \"bool :param visible: A value indicating if the control should be hidden or\",\n \"'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key':\",\n \"'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank',\",\n \"_attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'},\",\n \":type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str\",\n \"'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field\",\n \"'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon',\",\n \":class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type pages: list\",\n \"friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name\",\n \"page_type: object :param sections: The sections of the page. :type sections: list of\",\n \"are not. :type is_contribution: bool :param label: The label for the page. :type\",\n \"'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default\",\n \"'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id':\",\n \"description self.name = name self.projects = projects self.properties = properties self.reference_name = reference_name\",\n \"color: str :param description: :type description: str :param fields: :type fields: list of\",\n \"'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'},\",\n \"'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self,\",\n \"'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled',\",\n \"\\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type':\",\n \"= color self.hidden = hidden self.id = id self.name = name self.order =\",\n \"contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior.\",\n \"a child layout. :type overridden: bool :param read_only: A value indicating if the\",\n \":param id: :type id: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type':\",\n \":param locked: A value indicating whether any user operations are permitted on this\",\n \"'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'},\",\n \"<work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param\",\n \"for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put\",\n \"contribution self.controls = controls self.height = height self.id = id self.inherited = inherited\",\n \"been overridden by a child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map = {\",\n \"is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str\",\n \"behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel,\",\n \"'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key':\",\n \"str :param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param\",\n \"is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions list :type extensions:\",\n \"version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str :param id: :type id:\",\n \"'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None,\",\n \"'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id':\",\n \"should appear in the layout. :type order: int :param overridden: A value indicating\",\n \"type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity = is_identity\",\n \"behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url =\",\n \"self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior\",\n \"value indicating if the layout node is contribution or not. :type is_contribution: bool\",\n \"self.order = order self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark\",\n \":param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type':\",\n \"= { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled':\",\n \"= { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id':\",\n \"group should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map = {\",\n \"description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract\",\n \"contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution\",\n \"self.id = id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description:\",\n \"str :param overriden: :type overriden: bool :param rank: :type rank: int :param url:\",\n \"'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties',\",\n \"self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param url:\",\n \":type inherited: bool :param is_contribution: A value indicating if the layout node is\",\n \":param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type\",\n \":type abstract: bool :param color: :type color: str :param description: :type description: str\",\n \"overridden: bool :param visible: A value indicating if the group should be hidden\",\n \"pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type\",\n \"= parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str\",\n \"self).__init__() self.description = description self.id = id self.is_identity = is_identity self.name = name\",\n \"{ 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key':\",\n \"{'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type':\",\n \"This is expected to only be only set by the combiner. :type inherited:\",\n \"type_id: :type type_id: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},\",\n \"= inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool\",\n \"is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution:\",\n \"list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type\",\n \"super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height = height self.id =\",\n \"'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly',\",\n \"= inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order =\",\n \"_attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'},\",\n \"'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self,\",\n \"'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}\",\n \"id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param\",\n \"class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id: str\",\n \"'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type',\",\n \"self.properties = properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param\",\n \"= { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs':\",\n \"order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id\",\n \":type type_id: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name':\",\n \"'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible':\",\n \"= name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for the contribution. :type\",\n \"name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \\\"\\\"\\\"\",\n \"contribution are not. :type is_contribution: bool :param label: Label for the group. :type\",\n \"'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self,\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id =\",\n \"= icon self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout =\",\n \"self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata\",\n \":type overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id':\",\n \"WIT Id/Internal ReferenceName that it inherits from :type inherits: str :param is_disabled: :type\",\n \"key value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value\",\n \"inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type\",\n \":class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type id: str\",\n \"self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color self.description = description\",\n \"'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"overridden self.read_only = read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel.\",\n \"} def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height\",\n \"{'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type':\",\n \"for the contribution. :type height: int :param id: The id for the layout\",\n \"it inherits from :type inherits: str :param is_disabled: :type is_disabled: bool :param layout:\",\n \"self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the group. :type\",\n \"description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id\",\n \"super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value = value class Section(Model):\",\n \"rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description = description\",\n \"self.name = name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type:\",\n \"super(ProcessModel, self).__init__() self.description = description self.name = name self.projects = projects self.properties =\",\n \"groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the\",\n \"set by the combiner. :type inherited: bool :param is_contribution: A value indicating if\",\n \"'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'},\",\n \"show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color:\",\n \"in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height\",\n \":type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type\",\n \"field: :type field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map = {\",\n \":type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions',\",\n \"'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'},\",\n \":class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls: list of\",\n \":type icon: str :param id: :type id: str :param inherits: Parent WIT Id/Internal\",\n \"'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout':\",\n \"contribution. :type height: int :param inputs: A dictionary holding key value pairs for\",\n \"str :param order: Order in which the group should appear in the section.\",\n \"str :param type: :type type: object :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution\",\n \"self.name = name self.type = type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param\",\n \":param is_identity: :type is_identity: bool :param name: :type name: str :param type: :type\",\n \"height: int :param inputs: A dictionary holding key value pairs for contribution inputs.\",\n \"self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id = id self.is_disabled\",\n \"is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key':\",\n \"'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls',\",\n \"'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} }\",\n \"'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'},\",\n \"super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color self.description =\",\n \"= extensions self.pages = pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution:\",\n \"super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id =\",\n \"\\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default: bool :param is_enabled:\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key':\",\n \"'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type':\",\n \"'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None,\",\n \"class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>`\",\n \"__init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default =\",\n \"<work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type id: str :param\",\n \"id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls\",\n \"= id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata =\",\n \"= { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls':\",\n \"height for the contribution. :type height: int :param id: The id for the\",\n \"'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key':\",\n \":param control_type: Type of the control. :type control_type: str :param height: Height of\",\n \"Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt\",\n \"controls: Controls to be put in the group. :type controls: list of :class:`Control\",\n \"'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__()\",\n \"contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of\",\n \"str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param name:\",\n \"'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'}\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key':\",\n \"'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self,\",\n \"'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states',\",\n \"appear in the section. :type order: int :param overridden: A value indicating whether\",\n \"super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description = description self.fields =\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'},\",\n \"'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id\",\n \"contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label\",\n \"information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause\",\n \"= fields self.id = id self.inherits = inherits self.name = name self.overriden =\",\n \"\\\"\\\"\\\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type:\",\n \"super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name =\",\n \"a child layout. :type overridden: bool :param visible: A value indicating if the\",\n \"id self.name = name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type\",\n \"this page and the contents of this page :type locked: bool :param order:\",\n \"inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>`\",\n \"contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None):\",\n \"'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type =\",\n \"'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark',\",\n \"visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution\",\n \"'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None,\",\n \"the combiner. :type inherited: bool :param is_contribution: A value indicating if the layout\",\n \"url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden:\",\n \"'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None):\",\n \"reference_name: str :param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map = { 'description': {'key':\",\n \"self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name = name\",\n \"hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden =\",\n \"self.class_ = class_ self.color = color self.description = description self.icon = icon self.id\",\n \"groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden =\",\n \"\\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type':\",\n \"{'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type':\",\n \":param is_contribution: A value indicating if the layout node is contribution are not.\",\n \"locked: bool :param order: Order in which the page should appear in the\",\n \"id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits\",\n \"FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions list :type extensions: list of\",\n \"<work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color: str :param description:\",\n \":type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden:\",\n \"self.description = description self.fields = fields self.id = id self.inherits = inherits self.name\",\n \"layout node. :type id: str :param overridden: A value indicating whether this layout\",\n \"states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"Order in which the page should appear in the layout. :type order: int\",\n \"{'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type':\",\n \"behaviors self.class_ = class_ self.color = color self.description = description self.icon = icon\",\n \"id: :type id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \"for html controls. :type height: int :param id: The id for the layout\",\n \"FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type\",\n \"for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'},\",\n \"parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled\",\n \"# Licensed under the MIT License. See License.txt in the project root for\",\n \"{'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups\",\n \":class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height: int :param\",\n \"the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout\",\n \"parent_process_type_id: str :param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key':\",\n \"'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'},\",\n \":param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type\",\n \":type id: str :param inherited: A value indicating whether this layout node has\",\n \"= { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name':\",\n \"'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url =\",\n \"the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating\",\n \":type is_enabled: bool :param name: :type name: str \\\"\\\"\\\" _attribute_map = { 'description':\",\n \"{'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None,\",\n \"= { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity':\",\n \"} def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None,\",\n \":type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the\",\n \"been overridden by a child layout. :type overridden: bool :param read_only: A value\",\n \"incorrect behavior and will be lost if the code is regenerated. # --------------------------------------------------------------------------------------------\",\n \"self.color = color self.hidden = hidden self.id = id self.name = name self.order\",\n \"in which the group should appear in the section. :type order: int :param\",\n \":type control_type: str :param height: Height of the control, for html controls. :type\",\n \"'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name',\",\n \"\\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type':\",\n \"properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id: str\",\n \"str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId',\",\n \"not. :type is_contribution: bool :param label: The label for the page. :type label:\",\n \"contribution self.control_type = control_type self.height = height self.id = id self.inherited = inherited\",\n \"'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'}\",\n \"'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'},\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id\",\n \"'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key':\",\n \"overriden: :type overriden: bool :param rank: :type rank: int :param url: :type url:\",\n \"control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control,\",\n \":param name: :type name: str :param type: :type type: object :param url: :type\",\n \"'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description\",\n \"self.contribution = contribution self.control_type = control_type self.height = height self.id = id self.inherited\",\n \"{'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type':\",\n \"'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden',\",\n \":type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name:\",\n \"'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout',\",\n \"def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class\",\n \"'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None,\",\n \"layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color\",\n \"visible: bool :param watermark: Watermark text for the textbox. :type watermark: str \\\"\\\"\\\"\",\n \"__init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__()\",\n \"watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key':\",\n \"list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id:\",\n \":type state_category: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'color':\",\n \"\\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type':\",\n \"reference_name: :type reference_name: str :param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map = {\",\n \"behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type\",\n \"bool :param visible: A value indicating if the group should be hidden or\",\n \"'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url',\",\n \"name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key':\",\n \"<work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str :param height: Height\",\n \"= description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model):\",\n \":type name: str :param type: :type type: object :param url: :type url: str\",\n \"str :param metadata: Inner text of the control. :type metadata: str :param order:\",\n \"layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type\",\n \"self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item\",\n \"value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value = value class\",\n \"'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference,\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None,\",\n \"and will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization\",\n \"{ 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key':\",\n \":type name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default':\",\n \"str :param fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id:\",\n \"def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions\",\n \"of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id: str\",\n \"bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id',\",\n \"a child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups',\",\n \"conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param\",\n \"_attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'},\",\n \"url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url = url class\",\n \"_attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'},\",\n \"inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ =\",\n \"should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution':\",\n \"'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type =\",\n \"system_controls: Headers controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\"\",\n \"{'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type':\",\n \"id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel.\",\n \"inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution =\",\n \"class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str :param name: :type name: str\",\n \"bool :param name: :type name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description',\",\n \"icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors\",\n \":param target_field: :type target_field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map =\",\n \"'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None):\",\n \"super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model):\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None,\",\n \"actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of\",\n \"inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution =\",\n \"name: :type name: str :param order: :type order: int :param state_category: :type state_category:\",\n \"color: str :param hidden: :type hidden: bool :param id: :type id: str :param\",\n \":type overridden: bool :param page_type: The icon for the page. :type page_type: object\",\n \"= is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description:\",\n \"'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None,\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key':\",\n \"self.read_only = read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param\",\n \"= { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url':\",\n \"(c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See\",\n \"description: str :param name: :type name: str :param projects: :type projects: list of\",\n \"{'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type':\",\n \"self.order = order self.overridden = overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param\",\n \"def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default =\",\n \"'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color',\",\n \"= id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name =\",\n \"\\\"\\\"\\\"Group. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls:\",\n \"Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param\",\n \"inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param overriden: :type overriden: bool\",\n \"= type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param is_default: :type\",\n \"-------------------------------------------------------------------------------------------- # Generated file, DO NOT EDIT # Changes may cause incorrect behavior\",\n \"{'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type':\",\n \"str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties:\",\n \"group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the\",\n \"name: str :param type: :type type: object :param url: :type url: str \\\"\\\"\\\"\",\n \"control_type: str :param height: Height of the control, for html controls. :type height:\",\n \"child layout. :type overridden: bool :param page_type: The icon for the page. :type\",\n \"'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None,\",\n \"permitted on this page and the contents of this page :type locked: bool\",\n \"'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'},\",\n \"'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties':\",\n \"The id for the layout node. :type id: str :param overridden: A value\",\n \"} def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions =\",\n \"= id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked =\",\n \":type rank: int :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'abstract':\",\n \"code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param\",\n \"'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the page. :type\",\n \"been overridden by a child layout. :type overridden: bool :param visible: A value\",\n \"label self.metadata = metadata self.order = order self.overridden = overridden self.read_only = read_only\",\n \"node. :type id: str :param inherited: A value indicating whether this layout node\",\n \"id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description:\",\n \"bool :param label: Label for the group. :type label: str :param order: Order\",\n \"'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'},\",\n \"state_category: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'color': {'key':\",\n \":type is_contribution: bool :param label: Label for the group. :type label: str :param\",\n \"__init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value\",\n \"super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution =\",\n \"'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key':\",\n \":type id: str :param overridden: A value indicating whether this layout node has\",\n \"be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model\",\n \"overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default:\",\n \"overriden: bool :param rank: :type rank: int :param url: :type url: str \\\"\\\"\\\"\",\n \"{'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type':\",\n \"page_type self.sections = sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type\",\n \"id: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def\",\n \"name: :type name: str :param type: :type type: object :param url: :type url:\",\n \"contribution. :type contribution_id: str :param height: The height for the contribution. :type height:\",\n \"'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'},\",\n \"{'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None,\",\n \"version: :type version: str \\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'},\",\n \"label: str :param locked: A value indicating whether any user operations are permitted\",\n \"if the group should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map\",\n \"inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution should\",\n \"self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id for the contribution.\",\n \"'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id\",\n \"visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution\",\n \"= color self.description = description self.fields = fields self.id = id self.inherits =\",\n \"= url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default:\",\n \"order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution self.controls = controls self.height =\",\n \"\\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_:\",\n \":param id: :type id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"under the MIT License. See License.txt in the project root for license information.\",\n \"'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def\",\n \"'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId',\",\n \"class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param name: :type name: str\",\n \"WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type color: str :param\",\n \"control_type self.height = height self.id = id self.inherited = inherited self.is_contribution = is_contribution\",\n \"'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem',\",\n \"= class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version =\",\n \"the page should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map =\",\n \"'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description =\",\n \"only be only set by the combiner. :type inherited: bool :param is_contribution: A\",\n \"{'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type':\",\n \"def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field\",\n \"'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url':\",\n \"\\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param name: :type name: str :param parent_process_type_id:\",\n \"{'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties,\",\n \"this layout node has been overridden by a child layout. :type overridden: bool\",\n \"class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden: bool\",\n \"'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field\",\n \"self).__init__() self.action_type = action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel.\",\n \"name self.type = type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type\",\n \"child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups', 'type':\",\n \"'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None,\",\n \"is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled =\",\n \"'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id',\",\n \":param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name:\",\n \"bool :param read_only: A value indicating if the control is readonly. :type read_only:\",\n \"by a child layout. :type overridden: bool :param page_type: The icon for the\",\n \"'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version':\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference,\",\n \"= description self.fields = fields self.id = id self.inherits = inherits self.name =\",\n \"contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map =\",\n \"str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type name: str :param\",\n \":type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group.\",\n \"<work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type pages: list of\",\n \"'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None):\",\n \"{'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type':\",\n \":param contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls\",\n \":type order: int :param state_category: :type state_category: str :param url: :type url: str\",\n \":param description: :type description: str :param name: :type name: str :param projects: :type\",\n \"been inherited from a parent layout. This is expected to only be only\",\n \"control_type: Type of the control. :type control_type: str :param height: Height of the\",\n \"{'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type':\",\n \"def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default\",\n \"will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import\",\n \"\\\"\\\"\\\"WitContribution. :param contribution_id: The id for the contribution. :type contribution_id: str :param height:\",\n \":type description: str :param id: :type id: str :param is_identity: :type is_identity: bool\",\n \"= { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id':\",\n \"id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param name: :type\",\n \"of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = {\",\n \"def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field\",\n \"'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self,\",\n \"'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description\",\n \"= contribution self.control_type = control_type self.height = height self.id = id self.inherited =\",\n \"= conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system =\",\n \"'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order':\",\n \"'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__()\",\n \"'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__()\",\n \"<work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages',\",\n \"= { 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__()\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key':\",\n \"overridden by a child layout. :type overridden: bool :param read_only: A value indicating\",\n \"'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited',\",\n \"'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None,\",\n \":param overridden: A value indicating whether this layout node has been overridden by\",\n \"str \\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault',\",\n \"is_contribution: A value indicating if the layout node is contribution are not. :type\",\n \"'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None,\",\n \"system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls class\",\n \"the layout node is contribution are not. :type is_contribution: bool :param label: Label\",\n \"'[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key':\",\n \"{'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type':\",\n \"_attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'},\",\n \"id self.name = name self.order = order self.state_category = state_category self.url = url\",\n \"super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity = is_identity self.name =\",\n \"'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name',\",\n \"states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color\",\n \"__init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model):\",\n \"'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata':\",\n \":class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type id: str\",\n \"{'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type\",\n \"of the control. :type metadata: str :param order: :type order: int :param overridden:\",\n \"= description self.is_default = is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model):\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_':\",\n \"conditions self.friendly_name = friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system\",\n \"'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} }\",\n \":type label: str :param order: Order in which the group should appear in\",\n \"is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type name: str \\\"\\\"\\\"\",\n \"name: str :param order: :type order: int :param state_category: :type state_category: str :param\",\n \"'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled',\",\n \":param id: :type id: str :param name: :type name: str :param url: :type\",\n \"'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id =\",\n \"label self.order = order self.overridden = overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page.\",\n \"_attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}\",\n \"is_contribution self.label = label self.order = order self.overridden = overridden self.visible = visible\",\n \"class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str :param id: :type id: str\",\n \"<work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should be hidden or\",\n \"'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order':\",\n \"show on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key':\",\n \"label for the page. :type label: str :param locked: A value indicating whether\",\n \"FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str :param id: :type id: str :param\",\n \"{'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type':\",\n \"'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None,\",\n \"'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def\",\n \"import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the control. :type contribution:\",\n \"= id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str :param id: :type\",\n \":class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>`\",\n \"is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The\",\n \"the control. :type control_type: str :param height: Height of the control, for html\",\n \"overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited\",\n \"'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections':\",\n \"'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type\",\n \"= is_contribution self.label = label self.metadata = metadata self.order = order self.overridden =\",\n \"str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url',\",\n \"value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field:\",\n \"str :param order: :type order: int :param overridden: A value indicating whether this\",\n \"self).__init__() self.abstract = abstract self.color = color self.description = description self.fields = fields\",\n \"id self.inherits = inherits self.name = name self.overriden = overriden self.rank = rank\",\n \"read_only: A value indicating if the control is readonly. :type read_only: bool :param\",\n \"'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits',\",\n \"page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node.\",\n \":param label: The label for the page. :type label: str :param locked: A\",\n \"pages: Top level tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>`\",\n \"def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None,\",\n \"id: str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \\\"\\\"\\\"\",\n \"{'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None,\",\n \"def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None):\",\n \"'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None,\",\n \"= id self.inherits = inherits self.name = name self.overriden = overriden self.rank =\",\n \"'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_\",\n \"= name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id:\",\n \"str :param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType',\",\n \"'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank':\",\n \"of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls: list\",\n \"DO NOT EDIT # Changes may cause incorrect behavior and will be lost\",\n \":type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel\",\n \"visible: A value indicating if the control should be hidden or not. :type\",\n \":type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits:\",\n \"overridden by a child layout. :type overridden: bool :param visible: A value indicating\",\n \"{'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type':\",\n \":param name: :type name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>`\",\n \"'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel,\",\n \"on this page and the contents of this page :type locked: bool :param\",\n \"is_contribution: A value indicating if the layout node is contribution or not. :type\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color', 'type':\",\n \"layout. :type overridden: bool :param read_only: A value indicating if the control is\",\n \"'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type':\",\n \"'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled',\",\n \"indicating if the page should be hidden or not. :type visible: bool \\\"\\\"\\\"\",\n \"{ 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key':\",\n \"= system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the group. :type contribution:\",\n \"'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \\\"\\\"\\\"\",\n \":class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group. :type controls:\",\n \"'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits':\",\n \"{ 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key':\",\n \"is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id self.is_identity\",\n \"__init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name\",\n \"{'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type':\",\n \"self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order = order self.overridden\",\n \"MIT License. See License.txt in the project root for license information. # --------------------------------------------------------------------------------------------\",\n \"'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'},\",\n \"'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden':\",\n \"'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None):\",\n \"= overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param is_default: :type\",\n \"indicating if the control should be hidden or not. :type visible: bool :param\",\n \"of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages':\",\n \"'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None,\",\n \"from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the control.\",\n \"The id for the layout node. :type id: str :param inherited: A value\",\n \"'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None,\",\n \":type inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout\",\n \"= { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited':\",\n \"'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'name': {'key':\",\n \":param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object\",\n \"not. :type is_contribution: bool :param label: Label for the field :type label: str\",\n \"'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description\",\n \"Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the\",\n \"'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None,\",\n \"id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id = id\",\n \"self.is_enabled = is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id: The id\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type':\",\n \"or not. :type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type':\",\n \"whether this layout node has been overridden by a child layout. :type overridden:\",\n \"value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value = value class\",\n \"name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type\",\n \"is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param\",\n \"'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None,\",\n \"self.height = height self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label\",\n \"'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def\",\n \"A value indicating if the contribution should be show on deleted workItem. :type\",\n \"to only be only set by the combiner. :type inherited: bool :param is_contribution:\",\n \"inherits from :type inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type\",\n \"type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of\",\n \"_attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"description: :type description: str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled:\",\n \":param is_default: :type is_default: bool :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"{'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type':\",\n \"has been overridden by a child layout. :type overridden: bool :param visible: A\",\n \"visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key':\",\n \"'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'},\",\n \"that it inherits from :type inherits: str :param is_disabled: :type is_disabled: bool :param\",\n \"class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions:\",\n \"'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'}\",\n \":class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should be hidden\",\n \"super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model):\",\n \"inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type inherits: str :param\",\n \"= order self.overridden = overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param contribution:\",\n \"condition_type: :type condition_type: str :param field: :type field: str :param value: :type value:\",\n \"overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height\",\n \"self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param field:\",\n \"super(ProjectReference, self).__init__() self.description = description self.id = id self.name = name self.url =\",\n \"{'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type\",\n \"'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self,\",\n \"description: :type description: str :param id: :type id: str :param name: :type name:\",\n \"self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str :param id:\",\n \"self.controls = controls self.height = height self.id = id self.inherited = inherited self.is_contribution\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior\",\n \":class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color: str :param\",\n \"{'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__()\",\n \"\\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type':\",\n \"'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None,\",\n \"order: :type order: int :param overridden: A value indicating whether this layout node\",\n \"\\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id',\",\n \"_attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control.\",\n \"controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution =\",\n \"class_: object :param color: :type color: str :param description: :type description: str :param\",\n \"\\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None):\",\n \"'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order':\",\n \"'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled',\",\n \"order: :type order: int :param state_category: :type state_category: str :param url: :type url:\",\n \":type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id':\",\n \"id: str :param name: :type name: str :param order: :type order: int :param\",\n \"\\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field: str :param value:\",\n \"'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'}\",\n \"overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key':\",\n \"is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'},\",\n \"self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\" _attribute_map\",\n \"contribution or not. :type is_contribution: bool :param label: Label for the field :type\",\n \"contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group. :type\",\n \"'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"= metadata self.order = order self.overridden = overridden self.read_only = read_only self.visible =\",\n \"= color self.description = description self.icon = icon self.id = id self.inherits =\",\n \"id: str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type\",\n \"{'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type':\",\n \":param name: :type name: str :param overriden: :type overriden: bool :param rank: :type\",\n \"'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id':\",\n \"object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id:\",\n \"'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'},\",\n \"Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The\",\n \"'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId',\",\n \"control, for html controls. :type height: int :param id: The id for the\",\n \"bool :param name: :type name: str :param type: :type type: object :param url:\",\n \"'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category':\",\n \"= id self.name = name self.order = order self.state_category = state_category self.url =\",\n \"this layout node has been inherited from a parent layout. This is expected\",\n \"overridden: A value indicating whether this layout node has been overridden by a\",\n \"str :param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType',\",\n \"self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name\",\n \"locked self.order = order self.overridden = overridden self.page_type = page_type self.sections = sections\",\n \"= url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type\",\n \"height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__()\",\n \"visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key':\",\n \"reserved. # Licensed under the MIT License. See License.txt in the project root\",\n \":param name: :type name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type':\",\n \"'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self,\",\n \"self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param\",\n \":param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str\",\n \"indicating if the layout node is contribution or not. :type is_contribution: bool :param\",\n \"is_contribution=None, label=None, metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution\",\n \"\\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions:\",\n \"'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None):\",\n \"'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key':\",\n \"self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class\",\n \"'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id =\",\n \":param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map =\",\n \"A value indicating whether this layout node has been overridden by a child\",\n \"self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id:\",\n \"description: :type description: str :param icon: :type icon: str :param id: :type id:\",\n \"self.id = id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id:\",\n \":param order: :type order: int :param overridden: A value indicating whether this layout\",\n \"visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param\",\n \"'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model):\",\n \"sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level\",\n \":param abstract: :type abstract: bool :param color: :type color: str :param description: :type\",\n \"'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None,\",\n \"'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution',\",\n \"'object'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None,\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url':\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},\",\n \"layout node has been overridden by a child layout. :type overridden: bool :param\",\n \"fields self.id = id self.inherits = inherits self.name = name self.overriden = overriden\",\n \"= order self.overridden = overridden self.page_type = page_type self.sections = sections self.visible =\",\n \"_attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'},\",\n \":type reference_name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name':\",\n \"{'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type':\",\n \"list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type\",\n \"indicating whether this layout node has been inherited from a parent layout. This\",\n \"value: :type value: str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'},\",\n \":type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name:\",\n \"A value indicating whether this layout node has been inherited from a parent\",\n \"self.target_field = target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type:\",\n \"RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field: str :param\",\n \"'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key':\",\n \"'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} }\",\n \"'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__()\",\n \"'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'},\",\n \"not. :type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'},\",\n \"= url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type\",\n \"url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param\",\n \"'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution,\",\n \"bool :param is_contribution: A value indicating if the layout node is contribution are\",\n \"be show on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id':\",\n \":param controls: Controls to be put in the group. :type controls: list of\",\n \"of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param inherits: :type inherits: :class:`WorkItemBehaviorReference\",\n \"order self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark = watermark\",\n \"'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions\",\n \"'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None,\",\n \"'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None,\",\n \"self.overridden = overridden self.page_type = page_type self.sections = sections self.visible = visible class\",\n \"str \\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden',\",\n \"metadata: Inner text of the control. :type metadata: str :param order: :type order:\",\n \"Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for\",\n \"control should be hidden or not. :type visible: bool :param watermark: Watermark text\",\n \"= controls self.height = height self.id = id self.inherited = inherited self.is_contribution =\",\n \"group should appear in the section. :type order: int :param overridden: A value\",\n \"'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key':\",\n \":param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties\",\n \"reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects = projects\",\n \"= pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the\",\n \"'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key':\",\n \"'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'},\",\n \"has been inherited from a parent layout. This is expected to only be\",\n \"state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>`\",\n \":type label: str :param locked: A value indicating whether any user operations are\",\n \"self.label = label self.locked = locked self.order = order self.overridden = overridden self.page_type\",\n \"'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def\",\n \"'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None, name=None, projects=None,\",\n \"put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The\",\n \"'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label',\",\n \"'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value',\",\n \"value indicating whether this layout node has been inherited from a parent layout.\",\n \"been overridden by a child layout. :type overridden: bool :param page_type: The icon\",\n \"'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId',\",\n \"'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible':\",\n \"{ 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key':\",\n \":type friendly_name: str :param id: :type id: str :param is_disabled: :type is_disabled: bool\",\n \"= id self.name = name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type:\",\n \"control. :type metadata: str :param order: :type order: int :param overridden: A value\",\n \"super(Section, self).__init__() self.groups = groups self.id = id self.overridden = overridden class UpdateProcessModel(Model):\",\n \"self.description = description self.id = id self.name = name self.url = url class\",\n \"= label self.metadata = metadata self.order = order self.overridden = overridden self.read_only =\",\n \"name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color =\",\n \"id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str :param id: :type id:\",\n \"description: :type description: str :param id: :type id: str :param is_identity: :type is_identity:\",\n \"= contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model):\",\n \"if the control should be hidden or not. :type visible: bool :param watermark:\",\n \"= is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution. :param contribution_id:\",\n \"is_enabled: bool :param name: :type name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key':\",\n \"bool :param color: :type color: str :param description: :type description: str :param fields:\",\n \"'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url',\",\n \"{'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type':\",\n \"= description self.id = id self.name = name self.url = url class RuleActionModel(Model):\",\n \"of this page :type locked: bool :param order: Order in which the page\",\n \"} def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None,\",\n \"'[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout,\",\n \"} def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id =\",\n \"page should appear in the layout. :type order: int :param overridden: A value\",\n \"A value indicating if the control should be hidden or not. :type visible:\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default':\",\n \"<work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls: list of :class:`Control\",\n \"url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param target_field: :type target_field:\",\n \"= field self.value = value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list\",\n \"condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field = field self.value =\",\n \"'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'},\",\n \"'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param\",\n \"height for the contribution. :type height: int :param inputs: A dictionary holding key\",\n \"'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark':\",\n \"Label for the group. :type label: str :param order: Order in which the\",\n \"'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None,\",\n \"{'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None):\",\n \"= { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled':\",\n \"self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id\",\n \"of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name:\",\n \"'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions =\",\n \"self.abstract = abstract self.color = color self.description = description self.fields = fields self.id\",\n \"should be show on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = {\",\n \"is_contribution self.label = label self.locked = locked self.order = order self.overridden = overridden\",\n \"self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and\",\n \":param state_category: :type state_category: str :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"bool :param page_type: The icon for the page. :type page_type: object :param sections:\",\n \"'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key':\",\n \"'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden':\",\n \":type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url:\",\n \"control. :type control_type: str :param height: Height of the control, for html controls.\",\n \":type id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'id':\",\n \":param hidden: :type hidden: bool :param id: :type id: str :param name: :type\",\n \"'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} }\",\n \"description self.is_default = is_default self.is_enabled = is_enabled self.name = name class WitContribution(Model): \\\"\\\"\\\"WitContribution.\",\n \"self.metadata = metadata self.order = order self.overridden = overridden self.read_only = read_only self.visible\",\n \"parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str :param\",\n \":param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list\",\n \"color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden\",\n \"for the field :type label: str :param metadata: Inner text of the control.\",\n \"group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the\",\n \"inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order = order\",\n \"'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'},\",\n \"contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str :param\",\n \":param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str\",\n \"behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------------------------- from\",\n \"\\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type':\",\n \"the contents of this page :type locked: bool :param order: Order in which\",\n \"of the control. :type control_type: str :param height: Height of the control, for\",\n \"'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key':\",\n \"str :param id: :type id: str :param is_disabled: :type is_disabled: bool :param is_system:\",\n \"inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution should be show\",\n \"projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects\",\n \"{'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type':\",\n \"_attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'},\",\n \"'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None):\",\n \":type metadata: str :param order: :type order: int :param overridden: A value indicating\",\n \"'type': 'str'}, 'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name':\",\n \"'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key':\",\n \"= parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str\",\n \":type hidden: bool :param id: :type id: str :param name: :type name: str\",\n \"self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked = locked self.order\",\n \"by the combiner. :type inherited: bool :param is_contribution: A value indicating if the\",\n \"for the page. :type label: str :param locked: A value indicating whether any\",\n \"actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>`\",\n \":type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param type_id: :type type_id:\",\n \"'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name':\",\n \"extensions self.pages = pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution\",\n \"'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked',\",\n \":param reference_name: :type reference_name: str :param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map =\",\n \"'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A value indicating if\",\n \":type id: str :param name: :type name: str :param url: :type url: str\",\n \"for the contribution. :type contribution_id: str :param height: The height for the contribution.\",\n \"'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name',\",\n \"name self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id = type_id\",\n \"{'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type':\",\n \"'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key':\",\n \"the page. :type page_type: object :param sections: The sections of the page. :type\",\n \"{'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type':\",\n \"be hidden or not. :type visible: bool :param watermark: Watermark text for the\",\n \":type label: str :param metadata: Inner text of the control. :type metadata: str\",\n \"projects self.properties = properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties.\",\n \"'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key':\",\n \"{'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type':\",\n \"is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of\",\n \"value: str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key':\",\n \":type id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id':\",\n \"'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'},\",\n \"url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type\",\n \"for the layout node. :type id: str :param overridden: A value indicating whether\",\n \":type parent_process_type_id: str :param version: :type version: str \\\"\\\"\\\" _attribute_map = { 'class_':\",\n \"{'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None,\",\n \"inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param\",\n \"'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled':\",\n \"'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id =\",\n \"{'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None,\",\n \"whether this layout node has been inherited from a parent layout. This is\",\n \"behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url: str\",\n \"= class_ self.color = color self.description = description self.icon = icon self.id =\",\n \"= url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>`\",\n \":class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type of the control. :type control_type: str :param height:\",\n \"{ 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key':\",\n \":param description: :type description: str :param name: :type name: str :param parent_process_type_id: :type\",\n \"parent_process_type_id: str :param version: :type version: str \\\"\\\"\\\" _attribute_map = { 'class_': {'key':\",\n \"super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height = height self.id =\",\n \"{'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id\",\n \"super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value = value class RuleConditionModel(Model):\",\n \"'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel,\",\n \"'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None,\",\n \"are permitted on this page and the contents of this page :type locked:\",\n \"'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups\",\n \"__init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color = color\",\n \"'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url',\",\n \"indicating if the layout node is contribution are not. :type is_contribution: bool :param\",\n \"'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'},\",\n \"= value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type\",\n \"any user operations are permitted on this page and the contents of this\",\n \"'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url':\",\n \"<work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str :param\",\n \"= is_contribution self.label = label self.order = order self.overridden = overridden self.visible =\",\n \"self.class_ = class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version\",\n \"description self.fields = fields self.id = id self.inherits = inherits self.name = name\",\n \"sections: The sections of the page. :type sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param\",\n \"the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO NOT\",\n \":type type: object :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description':\",\n \"id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param\",\n \"parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id\",\n \"__init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None, id=None,\",\n \"{'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type':\",\n \"layout node has been inherited from a parent layout. This is expected to\",\n \"visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height = height\",\n \"'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'}\",\n \"'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__()\",\n \"self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions: :type actions: list of :class:`RuleActionModel\",\n \"color: :type color: str :param description: :type description: str :param fields: :type fields:\",\n \"def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description\",\n \"node is contribution or not. :type is_contribution: bool :param label: Label for the\",\n \"# -------------------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'},\",\n \"url: str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key':\",\n \"{'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type':\",\n \"label: str :param order: Order in which the group should appear in the\",\n \"'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}\",\n \"'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'},\",\n \"name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type\",\n \"bool \\\"\\\"\\\" _attribute_map = { 'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions',\",\n \"'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None,\",\n \":type overridden: bool :param visible: A value indicating if the group should be\",\n \"value indicating if the layout node is contribution are not. :type is_contribution: bool\",\n \"__init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name\",\n \":type order: int :param overridden: A value indicating whether this layout node has\",\n \"label: Label for the group. :type label: str :param order: Order in which\",\n \"__init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions\",\n \"url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description = description self.fields\",\n \"'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description',\",\n \"operations are permitted on this page and the contents of this page :type\",\n \"'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible':\",\n \"id: str :param is_identity: :type is_identity: bool :param name: :type name: str :param\",\n \"'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'}\",\n \"'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'},\",\n \"'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions\",\n \"'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def\",\n \"'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel,\",\n \"'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None,\",\n \"= locked self.order = order self.overridden = overridden self.page_type = page_type self.sections =\",\n \"Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License.\",\n \"int :param state_category: :type state_category: str :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"indicating if the contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool\",\n \"str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType',\",\n \":type behavior_field_id: str :param id: :type id: str :param url: :type url: str\",\n \"for the contribution. :type height: int :param inputs: A dictionary holding key value\",\n \"'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url':\",\n \"Parent WIT Id/Internal ReferenceName that it inherits from :type inherits: str :param is_disabled:\",\n \"child layout. :type overridden: bool :param visible: A value indicating if the group\",\n \"is contribution are not. :type is_contribution: bool :param label: The label for the\",\n \"contribution. :type height: int :param id: The id for the layout node. :type\",\n \"target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value = value\",\n \"self.overriden = overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param\",\n \"for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the\",\n \"Watermark text for the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution':\",\n \"{'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None,\",\n \"str :param description: :type description: str :param fields: :type fields: list of :class:`WorkItemBehaviorField\",\n \"\\\"\\\"\\\"ProcessModel. :param description: :type description: str :param name: :type name: str :param projects:\",\n \"{'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key': 'isContribution', 'type':\",\n \"{'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type':\",\n \"behavior_field_id: str :param id: :type id: str :param url: :type url: str \\\"\\\"\\\"\",\n \"layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the\",\n \"__init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height\",\n \":type description: str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool\",\n \"color: str :param description: :type description: str :param icon: :type icon: str :param\",\n \"'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None, fields=None,\",\n \"= name self.overriden = overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model):\",\n \"is_enabled: :type is_enabled: bool :param name: :type name: str \\\"\\\"\\\" _attribute_map = {\",\n \"contribution: Contribution for the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'behavior_field_id': {'key': 'behaviorFieldId', 'type': 'str'}, 'id':\",\n \"{ 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key':\",\n \"name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type\",\n \"super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id = id self.name =\",\n \"of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height: int\",\n \"\\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type':\",\n \"A value indicating if the page should be hidden or not. :type visible:\",\n \"self).__init__() self.color = color self.hidden = hidden self.id = id self.name = name\",\n \"= order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior:\",\n \"'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden',\",\n \":type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color:\",\n \"self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name\",\n \"self.overridden = overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for\",\n \"= height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract:\",\n \":param inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type inherits: str\",\n \"'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None, color=None, description=None,\",\n \"{'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type':\",\n \"class_: :type class_: object :param color: :type color: str :param description: :type description:\",\n \"the code is regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control.\",\n \"def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name =\",\n \"read_only self.visible = visible self.watermark = watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type\",\n \"url=None): super(WorkItemStateResultModel, self).__init__() self.color = color self.hidden = hidden self.id = id self.name\",\n \"the section. :type order: int :param overridden: A value indicating whether this layout\",\n \":type color: str :param hidden: :type hidden: bool :param id: :type id: str\",\n \"file, DO NOT EDIT # Changes may cause incorrect behavior and will be\",\n \"inputs: A dictionary holding key value pairs for contribution inputs. :type inputs: dict\",\n \"'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"id self.is_identity = is_identity self.name = name self.type = type self.url = url\",\n \":class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key':\",\n \"'watermark': {'key': 'watermark', 'type': 'str'} } def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None,\",\n \"value indicating if the group should be hidden or not. :type visible: bool\",\n \"is_default: bool :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key':\",\n \"node has been overridden by a child layout. :type overridden: bool :param page_type:\",\n \"the control. :type metadata: str :param order: :type order: int :param overridden: A\",\n \"id: :type id: str :param name: :type name: str :param order: :type order:\",\n \"self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str :param\",\n \"WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param\",\n \"id: str :param overridden: A value indicating whether this layout node has been\",\n \"'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"order: int :param state_category: :type state_category: str :param url: :type url: str \\\"\\\"\\\"\",\n \"the layout node. :type id: str :param overridden: A value indicating whether this\",\n \":type description: str :param icon: :type icon: str :param id: :type id: str\",\n \"id self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name = name\",\n \"str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits from :type inherits:\",\n \"is_contribution=None, label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution\",\n \"name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name\",\n \"self.is_contribution = is_contribution self.label = label self.locked = locked self.order = order self.overridden\",\n \":param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for\",\n \"condition_type: str :param field: :type field: str :param value: :type value: str \\\"\\\"\\\"\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id':\",\n \"object :param color: :type color: str :param description: :type description: str :param icon:\",\n \"'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id\",\n \"list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height:\",\n \"__init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__()\",\n \"behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param\",\n \"'[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages\",\n \"'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'},\",\n \"node. :type id: str :param overridden: A value indicating whether this layout node\",\n \"is_disabled: :type is_disabled: bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type\",\n \"'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self,\",\n \"value: :type value: str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'},\",\n \"extensions: Gets and sets extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param\",\n \"Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in\",\n \"{ 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key':\",\n \"user operations are permitted on this page and the contents of this page\",\n \"pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls\",\n \"} def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url = url\",\n \":param field: :type field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map =\",\n \"A value indicating if the control is readonly. :type read_only: bool :param visible:\",\n \"textbox. :type watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'},\",\n \"{ 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key':\",\n \"'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key':\",\n \"in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file, DO\",\n \"name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name\",\n \"bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls',\",\n \"self.contribution = contribution self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label\",\n \":param metadata: Inner text of the control. :type metadata: str :param order: :type\",\n \"has been overridden by a child layout. :type overridden: bool :param page_type: The\",\n \"'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}\",\n \"= url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type\",\n \":param visible: A value indicating if the control should be hidden or not.\",\n \":param id: The id for the layout node. :type id: str :param overridden:\",\n \"'{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None, show_on_deleted_work_item=None):\",\n \"bool :param label: Label for the field :type label: str :param metadata: Inner\",\n \"'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name',\",\n \"WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type\",\n \"'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__()\",\n \"'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} }\",\n \"fields: :type fields: list of :class:`WorkItemBehaviorField <work-item-tracking.v4_0.models.WorkItemBehaviorField>` :param id: :type id: str :param\",\n \"super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls class Group(Model):\",\n \"'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'is_system': {'key': 'isSystem',\",\n \"\\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type':\",\n \"html controls. :type height: int :param id: The id for the layout node.\",\n \":type height: int :param id: The id for the layout node. :type id:\",\n \"int :param id: The id for the layout node. :type id: str :param\",\n \"conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type\",\n \"self.id = id self.inherits = inherits self.name = name self.overriden = overriden self.rank\",\n \"metadata=None, order=None, overridden=None, read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type =\",\n \"if the control is readonly. :type read_only: bool :param visible: A value indicating\",\n \":class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name: str\",\n \"\\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type':\",\n \"'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'},\",\n \"'description': {'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'projects': {'key': 'projects',\",\n \"behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param url: :type url:\",\n \"} def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None):\",\n \"<work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states: :type states: list of :class:`WorkItemStateResultModel\",\n \"bool :param id: :type id: str :param name: :type name: str :param order:\",\n \"list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'},\",\n \"the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions':\",\n \"'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key':\",\n \":type color: str :param description: :type description: str :param icon: :type icon: str\",\n \":type version: str \\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default':\",\n \"= page_type self.sections = sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description:\",\n \"<work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name:\",\n \":type locked: bool :param order: Order in which the page should appear in\",\n \"self.contribution = contribution self.controls = controls self.height = height self.id = id self.inherited\",\n \"contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id for the layout node. :type id:\",\n \"is_contribution: bool :param label: The label for the page. :type label: str :param\",\n \"str :param name: :type name: str :param order: :type order: int :param state_category:\",\n \"= action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type:\",\n \"'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key':\",\n \"'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'},\",\n \":param class_: :type class_: object :param color: :type color: str :param description: :type\",\n \"'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'},\",\n \"'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description =\",\n \"'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'url': {'key': 'url',\",\n \"str :param overridden: A value indicating whether this layout node has been overridden\",\n \"{'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type':\",\n \"= { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height':\",\n \"self.inherits = inherits self.name = name self.overriden = overriden self.rank = rank self.url\",\n \"deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type':\",\n \"= is_identity self.name = name self.type = type self.url = url class FieldRuleModel(Model):\",\n \"inherited: A value indicating whether this layout node has been inherited from a\",\n \"\\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type':\",\n \"\\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type':\",\n \"'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None, name=None,\",\n \"target_field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key':\",\n \"color self.description = description self.fields = fields self.id = id self.inherits = inherits\",\n \"'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} }\",\n \"self.behavior = behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param\",\n \"{ 'id': {'key': 'id', 'type': 'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id\",\n \"'name', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, description=None, id=None,\",\n \"{'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type':\",\n \"'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id\",\n \"def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None,\",\n \"str \\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField',\",\n \"'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only':\",\n \"extensions list :type extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs\",\n \"= is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model):\",\n \":type description: str :param name: :type name: str :param projects: :type projects: list\",\n \"description self.icon = icon self.id = id self.inherits = inherits self.is_disabled = is_disabled\",\n \"{'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__()\",\n \"'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def\",\n \"should appear in the section. :type order: int :param overridden: A value indicating\",\n \"'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key':\",\n \"_attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'},\",\n \"actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions =\",\n \":type description: str :param name: :type name: str :param parent_process_type_id: :type parent_process_type_id: str\",\n \"pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group. :param contribution: Contribution for the group.\",\n \"class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>`\",\n \"from :type inherits: str :param is_disabled: :type is_disabled: bool :param layout: :type layout:\",\n \"height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type\",\n \"'isDefault', 'type': 'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None,\",\n \"'str'}, 'version': {'key': 'version', 'type': 'str'} } def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None,\",\n \":type parent_process_type_id: str :param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map = { 'description':\",\n \":type name: str :param states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url:\",\n \"the layout node is contribution are not. :type is_contribution: bool :param label: The\",\n \"_attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'},\",\n \"bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id',\",\n \"id: :type id: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'}\",\n \"Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param\",\n \"controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type\",\n \"'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None):\",\n \"value indicating whether any user operations are permitted on this page and the\",\n \"self.action_type = action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param\",\n \"self.height = height self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param\",\n \"= { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'url':\",\n \"overridden self.page_type = page_type self.sections = sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel.\",\n \"str :param name: :type name: str :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color self.description =\",\n \"-------------------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the\",\n \"'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name': {'key':\",\n \"'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden':\",\n \"<work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution. :type height: int :param id:\",\n \"'actions': {'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName',\",\n \"class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__()\",\n \"list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should\",\n \"hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution',\",\n \"The icon for the page. :type page_type: object :param sections: The sections of\",\n \"is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name\",\n \"is readonly. :type read_only: bool :param visible: A value indicating if the control\",\n \"'str'}, 'name': {'key': 'name', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'state_category': {'key':\",\n \"visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str :param name: :type name:\",\n \"'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden',\",\n \"self.name = name self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id\",\n \"name: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key':\",\n \"which the page should appear in the layout. :type order: int :param overridden:\",\n \"page and the contents of this page :type locked: bool :param order: Order\",\n \":param order: Order in which the page should appear in the layout. :type\",\n \"'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution':\",\n \"__init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default\",\n \"self).__init__() self.condition_type = condition_type self.field = field self.value = value class Section(Model): \\\"\\\"\\\"Section.\",\n \":type id: str :param inherits: Parent WIT Id/Internal ReferenceName that it inherits from\",\n \"metadata self.order = order self.overridden = overridden self.read_only = read_only self.visible = visible\",\n \"'[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key':\",\n \"= visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the page. :type contribution:\",\n \"= condition_type self.field = field self.value = value class Section(Model): \\\"\\\"\\\"Section. :param groups:\",\n \"order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type\",\n \"{'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type':\",\n \":param icon: :type icon: str :param id: :type id: str :param inherits: Parent\",\n \"behavior_field_id self.id = id self.url = url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type\",\n \"be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key':\",\n \"the control should be hidden or not. :type visible: bool :param watermark: Watermark\",\n \"\\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions list :type extensions: list of :class:`Extension\",\n \"label=None, locked=None, order=None, overridden=None, page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id\",\n \"ProjectReference(Model): \\\"\\\"\\\"ProjectReference. :param description: :type description: str :param id: :type id: str :param\",\n \"self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.order\",\n \"layout. :type order: int :param overridden: A value indicating whether this layout node\",\n \"is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version:\",\n \"'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'read_only': {'key': 'readOnly', 'type': 'bool'}, 'visible': {'key':\",\n \"version: str \\\"\\\"\\\" _attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key':\",\n \"self.inputs = inputs self.show_on_deleted_work_item = show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract:\",\n \"friendly_name: str :param id: :type id: str :param is_disabled: :type is_disabled: bool :param\",\n \"Controls to be put in the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>`\",\n \"self.condition_type = condition_type self.field = field self.value = value class Section(Model): \\\"\\\"\\\"Section. :param\",\n \"'bool'}, 'visible': {'key': 'visible', 'type': 'bool'}, 'watermark': {'key': 'watermark', 'type': 'str'} } def\",\n \":type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height':\",\n \":type visible: bool \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls':\",\n \"'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key':\",\n \"'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description\",\n \":param description: :type description: str :param id: :type id: str :param is_identity: :type\",\n \"'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'},\",\n \"'type': 'str'} } def __init__(self, id=None, url=None): super(WorkItemBehaviorReference, self).__init__() self.id = id self.url\",\n \"= { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height':\",\n \"= id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str\",\n \"'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id':\",\n \"overridden=None): super(Section, self).__init__() self.groups = groups self.id = id self.overridden = overridden class\",\n \":type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for the contribution.\",\n \"id for the contribution. :type contribution_id: str :param height: The height for the\",\n \":param action_type: :type action_type: str :param target_field: :type target_field: str :param value: :type\",\n \"regenerated. # -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution\",\n \"is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled =\",\n \"# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT\",\n \"inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color = color\",\n \"= name self.type = type self.url = url class FieldRuleModel(Model): \\\"\\\"\\\"FieldRuleModel. :param actions:\",\n \"\\\"\\\"\\\" _attribute_map = { 'action_type': {'key': 'actionType', 'type': 'str'}, 'target_field': {'key': 'targetField', 'type':\",\n \"label self.locked = locked self.order = order self.overridden = overridden self.page_type = page_type\",\n \"= value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>`\",\n \"\\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type':\",\n \"inherits self.is_disabled = is_disabled self.layout = layout self.name = name self.states = states\",\n \"reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\" _attribute_map = {\",\n \"has been overridden by a child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map =\",\n \"object :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description',\",\n \"{'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type':\",\n \"\\\"\\\"\\\"Page. :param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id:\",\n \"str :param target_field: :type target_field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map\",\n \"bool :param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \\\"\\\"\\\" _attribute_map\",\n \"{'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type':\",\n \"should be hidden or not. :type visible: bool :param watermark: Watermark text for\",\n \":class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id: :type id: str :param\",\n \"are not. :type is_contribution: bool :param label: Label for the group. :type label:\",\n \"read_only=None, visible=None, watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height =\",\n \"self.description = description self.id = id self.is_identity = is_identity self.name = name self.type\",\n \"action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value =\",\n \"'bool'}, 'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key':\",\n \"{'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions\",\n \"list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id for the layout node. :type\",\n \":type id: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type': 'str'} }\",\n \":type class_: object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool\",\n \"in the layout. :type order: int :param overridden: A value indicating whether this\",\n \"str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id',\",\n \"groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description: :type\",\n \"{'key': 'order', 'type': 'int'}, 'state_category': {'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type':\",\n \"'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id',\",\n \"url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type': '[WorkItemTypeBehavior]'},\",\n \"'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None,\",\n \"'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key':\",\n \"self.control_type = control_type self.height = height self.id = id self.inherited = inherited self.is_contribution\",\n \"\\\"\\\"\\\"UpdateProcessModel. :param description: :type description: str :param is_default: :type is_default: bool :param is_enabled:\",\n \"description: str :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param\",\n \"'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'visible': {'key': 'visible',\",\n \"super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name =\",\n \"{'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type':\",\n \"'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups =\",\n \"self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str :param target_field:\",\n \"self.page_type = page_type self.sections = sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param\",\n \"'is_enabled': {'key': 'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version',\",\n \"str \\\"\\\"\\\" _attribute_map = { 'behavior': {'key': 'behavior', 'type': 'WorkItemBehaviorReference'}, 'is_default': {'key': 'isDefault',\",\n \"is contribution are not. :type is_contribution: bool :param label: Label for the group.\",\n \":param color: :type color: str :param description: :type description: str :param fields: :type\",\n \"the MIT License. See License.txt in the project root for license information. #\",\n \"The id for the contribution. :type contribution_id: str :param height: The height for\",\n \"self.id = id self.name = name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param\",\n \"extensions: list of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout.\",\n \"properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description = description self.name = name self.projects =\",\n \"inherited self.is_contribution = is_contribution self.label = label self.locked = locked self.order = order\",\n \"node has been overridden by a child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map\",\n \"'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None, target_field=None, value=None):\",\n \"{ 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key':\",\n \":type url: str \\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden':\",\n \"'description', 'type': 'str'}, 'icon': {'key': 'icon', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"# -------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for\",\n \"'overridden', 'type': 'bool'}, 'visible': {'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None,\",\n \"{ 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key':\",\n \"friendly_name: :type friendly_name: str :param id: :type id: str :param is_disabled: :type is_disabled:\",\n \"id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked = locked\",\n \":class:`RuleActionModel <work-item-tracking.v4_0.models.RuleActionModel>` :param conditions: :type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type\",\n \"value indicating whether this layout node has been overridden by a child layout.\",\n \"Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution\",\n \"section. :type order: int :param overridden: A value indicating whether this layout node\",\n \"str :param order: :type order: int :param state_category: :type state_category: str :param url:\",\n \"description: :type description: str :param name: :type name: str :param projects: :type projects:\",\n \"condition_type self.field = field self.value = value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type\",\n \"'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, is_disabled=None, is_system=None): super(FieldRuleModel, self).__init__()\",\n \"'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'controls': {'key': 'controls', 'type': '[Control]'}, 'height': {'key': 'height',\",\n \"'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel,\",\n \"properties self.reference_name = reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type\",\n \"def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description:\",\n \"'behaviorFieldId', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'}\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'id': {'key': 'id', 'type':\",\n \"inherited: bool :param is_contribution: A value indicating if the layout node is contribution\",\n \":param contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The\",\n \"page. :type label: str :param locked: A value indicating whether any user operations\",\n \"height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution = contribution\",\n \"} def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type self.field =\",\n \"watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param name: :type name:\",\n \":type value: str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field':\",\n \"'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField,\",\n \"'layout', 'type': 'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'},\",\n \"layout node has been overridden by a child layout. :type overridden: bool \\\"\\\"\\\"\",\n \"'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key':\",\n \"'[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def\",\n \"'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'control_type': {'key': 'controlType', 'type': 'str'}, 'height': {'key': 'height',\",\n \"'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def\",\n \"'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id',\",\n \"<work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map\",\n \"page_type=None, sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited =\",\n \"bool :param watermark: Watermark text for the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map\",\n \"sections=None, visible=None): super(Page, self).__init__() self.contribution = contribution self.id = id self.inherited = inherited\",\n \"{'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type':\",\n \"'type': 'str'}, 'target_field': {'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} }\",\n \"field :type label: str :param metadata: Inner text of the control. :type metadata:\",\n \"{'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None,\",\n \"color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract =\",\n \"'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited':\",\n \"= behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors:\",\n \"= description self.icon = icon self.id = id self.inherits = inherits self.is_disabled =\",\n \"= name self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id =\",\n \"= { 'abstract': {'key': 'abstract', 'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description':\",\n \"is_contribution: bool :param label: Label for the field :type label: str :param metadata:\",\n \"The height for the contribution. :type height: int :param inputs: A dictionary holding\",\n \"parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str \\\"\\\"\\\" _attribute_map = {\",\n \"class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default: bool\",\n \"'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs', 'type': '{object}'},\",\n \"a child layout. :type overridden: bool :param page_type: The icon for the page.\",\n \"by a child layout. :type overridden: bool :param read_only: A value indicating if\",\n \"'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__() self.condition_type = condition_type\",\n \"'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'},\",\n \"'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited',\",\n \"= inherits self.is_disabled = is_disabled self.layout = layout self.name = name self.states =\",\n \"= { 'id': {'key': 'id', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"'visible', 'type': 'bool'} } def __init__(self, contribution=None, id=None, inherited=None, is_contribution=None, label=None, locked=None, order=None,\",\n \":param condition_type: :type condition_type: str :param field: :type field: str :param value: :type\",\n \"the control is readonly. :type read_only: bool :param visible: A value indicating if\",\n \"__init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url\",\n \"id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata\",\n \"'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def\",\n \"self.behaviors = behaviors self.class_ = class_ self.color = color self.description = description self.icon\",\n \"'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type': 'str'}, 'overriden': {'key': 'overriden', 'type': 'bool'}, 'rank': {'key':\",\n \"by a child layout. :type overridden: bool \\\"\\\"\\\" _attribute_map = { 'groups': {'key':\",\n \"= is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list\",\n \"parent layout. This is expected to only be only set by the combiner.\",\n \"may cause incorrect behavior and will be lost if the code is regenerated.\",\n \"'type': 'bool'}, 'is_system': {'key': 'isSystem', 'type': 'bool'} } def __init__(self, actions=None, conditions=None, friendly_name=None,\",\n \"} def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default =\",\n \"self.id = id self.name = name self.order = order self.state_category = state_category self.url\",\n \"str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field',\",\n \"'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__()\",\n \"height self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label\",\n \":type action_type: str :param target_field: :type target_field: str :param value: :type value: str\",\n \"name self.order = order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior.\",\n \"self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior:\",\n \"'[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def\",\n \"def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group,\",\n \"states: :type states: list of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\"\",\n \"self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name = reference_name class\",\n \"is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type name:\",\n \"All rights reserved. # Licensed under the MIT License. See License.txt in the\",\n \"only set by the combiner. :type inherited: bool :param is_contribution: A value indicating\",\n \"description self.id = id self.name = name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel.\",\n \"_attribute_map = { 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'},\",\n \"is_identity: :type is_identity: bool :param name: :type name: str :param type: :type type:\",\n \"'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name': {'key': 'referenceName',\",\n \"self.fields = fields self.id = id self.inherits = inherits self.name = name self.overriden\",\n \"the group. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in\",\n \"icon: str :param id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName\",\n \"str :param id: :type id: str :param inherits: Parent WIT Id/Internal ReferenceName that\",\n \"self.field = field self.value = value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups:\",\n \"of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page should be\",\n \"'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'}, 'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key':\",\n \"'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'},\",\n \"= id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str\",\n \"the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type':\",\n \"'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited':\",\n \"'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key':\",\n \"self.value = value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list of :class:`Group\",\n \"'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'}\",\n \"A value indicating if the layout node is contribution are not. :type is_contribution:\",\n \"'projects': {'key': 'projects', 'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName',\",\n \"{'key': 'friendlyName', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_disabled': {'key': 'isDisabled', 'type':\",\n \"__init__(self, action_type=None, target_field=None, value=None): super(RuleActionModel, self).__init__() self.action_type = action_type self.target_field = target_field self.value\",\n \"node is contribution are not. :type is_contribution: bool :param label: Label for the\",\n \"'type': 'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__()\",\n \"__init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type\",\n \"= is_disabled self.layout = layout self.name = name self.states = states self.url =\",\n \"super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id =\",\n \"the contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map\",\n \"'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type': 'str'},\",\n \"{'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key': 'url', 'type':\",\n \"self.description = description self.icon = icon self.id = id self.inherits = inherits self.is_disabled\",\n \":param contribution: Contribution for the control. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param control_type: Type\",\n \"combiner. :type inherited: bool :param is_contribution: A value indicating if the layout node\",\n \"layout node is contribution are not. :type is_contribution: bool :param label: The label\",\n \":class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key':\",\n \"reference_name=None): super(CreateProcessModel, self).__init__() self.description = description self.name = name self.parent_process_type_id = parent_process_type_id self.reference_name\",\n \"self.projects = projects self.properties = properties self.reference_name = reference_name self.type_id = type_id class\",\n \"'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self,\",\n \"friendly_name self.id = id self.is_disabled = is_disabled self.is_system = is_system class FormLayout(Model): \\\"\\\"\\\"FormLayout.\",\n \"License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- # Generated file,\",\n \"abstract self.color = color self.description = description self.fields = fields self.id = id\",\n \"Top level tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param\",\n \"sections: list of :class:`Section <work-item-tracking.v4_0.models.Section>` :param visible: A value indicating if the page\",\n \"<work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors',\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behaviors': {'key': 'behaviors', 'type':\",\n \"'inputs', 'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None,\",\n \"self).__init__() self.description = description self.id = id self.name = name self.url = url\",\n \"A value indicating if the layout node is contribution or not. :type is_contribution:\",\n \"'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden',\",\n \"{'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type':\",\n \"_attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None): super(WorkItemStateResultModel, self).__init__() self.color =\",\n \":type page_type: object :param sections: The sections of the page. :type sections: list\",\n \"'is_contribution': {'key': 'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order',\",\n \"overriden self.rank = rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type\",\n \"name: :type name: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'},\",\n \"action_type self.target_field = target_field self.value = value class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type\",\n \"has been overridden by a child layout. :type overridden: bool :param read_only: A\",\n \"is_default=None, url=None): super(WorkItemTypeBehavior, self).__init__() self.behavior = behavior self.is_default = is_default self.url = url\",\n \"and the contents of this page :type locked: bool :param order: Order in\",\n \"= groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel. :param description:\",\n \"\\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color', 'type': 'str'}, 'hidden': {'key': 'hidden', 'type':\",\n \"text of the control. :type metadata: str :param order: :type order: int :param\",\n \"id: The id for the layout node. :type id: str :param inherited: A\",\n \"url class WorkItemBehaviorReference(Model): \\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url:\",\n \"ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default: bool :param\",\n \":param order: Order in which the group should appear in the section. :type\",\n \":param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'abstract': {'key': 'abstract', 'type':\",\n \"in which the page should appear in the layout. :type order: int :param\",\n \"Id/Internal ReferenceName that it inherits from :type inherits: str :param is_disabled: :type is_disabled:\",\n \"contents of this page :type locked: bool :param order: Order in which the\",\n \"'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'metadata': {'key': 'metadata', 'type': 'str'}, 'order': {'key':\",\n \"this page :type locked: bool :param order: Order in which the page should\",\n \"a parent layout. This is expected to only be only set by the\",\n \"inherits self.name = name self.overriden = overriden self.rank = rank self.url = url\",\n \":param id: The id for the layout node. :type id: str :param inherited:\",\n \"str :param icon: :type icon: str :param id: :type id: str :param inherits:\",\n \"overridden: bool :param read_only: A value indicating if the control is readonly. :type\",\n \"system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map = { 'extensions': {'key': 'extensions', 'type':\",\n \"class_ self.is_default = is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version\",\n \"self.rank = rank self.url = url class WorkItemBehaviorField(Model): \\\"\\\"\\\"WorkItemBehaviorField. :param behavior_field_id: :type behavior_field_id:\",\n \":param parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \\\"\\\"\\\" _attribute_map =\",\n \"overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution for the page.\",\n \"self.label = label self.metadata = metadata self.order = order self.overridden = overridden self.read_only\",\n \"'str'} } def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel.\",\n \"'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None, field=None, value=None): super(RuleConditionModel, self).__init__()\",\n \"NOT EDIT # Changes may cause incorrect behavior and will be lost if\",\n \"'type': 'bool'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields':\",\n \"self).__init__() self.extensions = extensions self.pages = pages self.system_controls = system_controls class Group(Model): \\\"\\\"\\\"Group.\",\n \"WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None,\",\n \"height: The height for the contribution. :type height: int :param id: The id\",\n \"layout. :type overridden: bool :param page_type: The icon for the page. :type page_type:\",\n \"str :param hidden: :type hidden: bool :param id: :type id: str :param name:\",\n \"License. See License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- #\",\n \"{'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'}, 'name': {'key': 'name', 'type':\",\n \"Label for the field :type label: str :param metadata: Inner text of the\",\n \"_attribute_map = { 'extensions': {'key': 'extensions', 'type': '[Extension]'}, 'pages': {'key': 'pages', 'type': '[Page]'},\",\n \"-------------------------------------------------------------------------------------------- from msrest.serialization import Model class Control(Model): \\\"\\\"\\\"Control. :param contribution: Contribution for the\",\n \"self.id = id self.url = url class WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color:\",\n \"icon for the page. :type page_type: object :param sections: The sections of the\",\n \":type conditions: list of :class:`RuleConditionModel <work-item-tracking.v4_0.models.RuleConditionModel>` :param friendly_name: :type friendly_name: str :param id:\",\n \":type id: str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool\",\n \"{'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, abstract=None,\",\n \":param type_id: :type type_id: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type':\",\n \"show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key':\",\n \":type is_contribution: bool :param label: The label for the page. :type label: str\",\n \"holding key value pairs for contribution inputs. :type inputs: dict :param show_on_deleted_work_item: A\",\n \"is_enabled=None, name=None): super(UpdateProcessModel, self).__init__() self.description = description self.is_default = is_default self.is_enabled = is_enabled\",\n \"{'key': 'pages', 'type': '[Page]'}, 'system_controls': {'key': 'systemControls', 'type': '[Control]'} } def __init__(self, extensions=None,\",\n \"contribution: Contribution for the page. :type contribution: :class:`WitContribution <work-item-tracking.v4_0.models.WitContribution>` :param id: The id\",\n \"} def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_\",\n \"or not. :type is_contribution: bool :param label: Label for the field :type label:\",\n \"name: :type name: str :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \"= name self.order = order self.state_category = state_category self.url = url class WorkItemTypeBehavior(Model):\",\n \"'contribution_id': {'key': 'contributionId', 'type': 'str'}, 'height': {'key': 'height', 'type': 'int'}, 'inputs': {'key': 'inputs',\",\n \":param behavior_field_id: :type behavior_field_id: str :param id: :type id: str :param url: :type\",\n \"} def __init__(self, abstract=None, color=None, description=None, fields=None, id=None, inherits=None, name=None, overriden=None, rank=None, url=None):\",\n \"'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden': {'key': 'overridden', 'type': 'bool'},\",\n \"= watermark class CreateProcessModel(Model): \\\"\\\"\\\"CreateProcessModel. :param description: :type description: str :param name: :type\",\n \"= overridden self.page_type = page_type self.sections = sections self.visible = visible class ProcessModel(Model):\",\n \"if the contribution should be show on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\"\",\n \"'page_type': {'key': 'pageType', 'type': 'object'}, 'sections': {'key': 'sections', 'type': '[Section]'}, 'visible': {'key': 'visible',\",\n \"in the section. :type order: int :param overridden: A value indicating whether this\",\n \"overridden by a child layout. :type overridden: bool :param page_type: The icon for\",\n \"self.description = description self.name = name self.projects = projects self.properties = properties self.reference_name\",\n \"'type': 'str'}, 'type': {'key': 'type', 'type': 'object'}, 'url': {'key': 'url', 'type': 'str'} }\",\n \"Height of the control, for html controls. :type height: int :param id: The\",\n \"bool :param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param\",\n \"} def __init__(self, id=None): super(Extension, self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param\",\n \"if the page should be hidden or not. :type visible: bool \\\"\\\"\\\" _attribute_map\",\n \"behavior self.is_default = is_default self.url = url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type\",\n \":param name: :type name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>`\",\n \":type name: str :param parent_process_type_id: :type parent_process_type_id: str :param reference_name: :type reference_name: str\",\n \"\\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type':\",\n \"tabs of the layout. :type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers\",\n \"indicating if the group should be hidden or not. :type visible: bool \\\"\\\"\\\"\",\n \"is_default=None, is_enabled=None, parent_process_type_id=None, version=None): super(ProcessProperties, self).__init__() self.class_ = class_ self.is_default = is_default self.is_enabled\",\n \"expected to only be only set by the combiner. :type inherited: bool :param\",\n \"self).__init__() self.contribution = contribution self.control_type = control_type self.height = height self.id = id\",\n \"color: :type color: str :param hidden: :type hidden: bool :param id: :type id:\",\n \"'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} }\",\n \"on deleted workItem. :type show_on_deleted_work_item: bool \\\"\\\"\\\" _attribute_map = { 'contribution_id': {'key': 'contributionId',\",\n \"'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields',\",\n \"'overriden', 'type': 'bool'}, 'rank': {'key': 'rank', 'type': 'int'}, 'url': {'key': 'url', 'type': 'str'}\",\n \"hidden: :type hidden: bool :param id: :type id: str :param name: :type name:\",\n \"'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None, is_default=None, is_enabled=None,\",\n \"class RuleConditionModel(Model): \\\"\\\"\\\"RuleConditionModel. :param condition_type: :type condition_type: str :param field: :type field: str\",\n \"{'key': 'isEnabled', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'} } def __init__(self, description=None,\",\n \"str :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'color': {'key': 'color',\",\n \":param layout: :type layout: :class:`FormLayout <work-item-tracking.v4_0.models.FormLayout>` :param name: :type name: str :param states:\",\n \"description: str :param id: :type id: str :param name: :type name: str :param\",\n \"'description', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'},\",\n \"= show_on_deleted_work_item class WorkItemBehavior(Model): \\\"\\\"\\\"WorkItemBehavior. :param abstract: :type abstract: bool :param color: :type\",\n \"'str'}, 'reference_name': {'key': 'referenceName', 'type': 'str'} } def __init__(self, description=None, name=None, parent_process_type_id=None, reference_name=None):\",\n \"__init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel, self).__init__() self.description = description self.id\",\n \"= url class WorkItemTypeModel(Model): \\\"\\\"\\\"WorkItemTypeModel. :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>`\",\n \"= name self.url = url class RuleActionModel(Model): \\\"\\\"\\\"RuleActionModel. :param action_type: :type action_type: str\",\n \"super(Extension, self).__init__() self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str\",\n \"the layout node. :type id: str :param inherited: A value indicating whether this\",\n \"list of :class:`WorkItemTypeBehavior <work-item-tracking.v4_0.models.WorkItemTypeBehavior>` :param class_: :type class_: object :param color: :type color:\",\n \":param system_controls: Headers controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>`\",\n \"abstract: bool :param color: :type color: str :param description: :type description: str :param\",\n \"self.inherited = inherited self.is_contribution = is_contribution self.label = label self.metadata = metadata self.order\",\n \"parent_process_type_id self.reference_name = reference_name class Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\"\",\n \"of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param properties: :type properties: :class:`ProcessProperties <work-item-tracking.v4_0.models.ProcessProperties>` :param reference_name: :type reference_name:\",\n \"{'key': 'contribution', 'type': 'WitContribution'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type':\",\n \"super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs = inputs self.show_on_deleted_work_item =\",\n \"height: Height of the control, for html controls. :type height: int :param id:\",\n \"'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None, url=None):\",\n \"'str'}, 'overridden': {'key': 'overridden', 'type': 'bool'} } def __init__(self, groups=None, id=None, overridden=None): super(Section,\",\n \"class WorkItemTypeBehavior(Model): \\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default:\",\n \"{'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None, order=None, state_category=None,\",\n \":type name: str :param order: :type order: int :param state_category: :type state_category: str\",\n \"str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault',\",\n \"'controls', 'type': '[Control]'}, 'height': {'key': 'height', 'type': 'int'}, 'id': {'key': 'id', 'type': 'str'},\",\n \"{'key': 'description', 'type': 'str'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type':\",\n \"color: :type color: str :param description: :type description: str :param icon: :type icon:\",\n \"\\\"\\\"\\\"WorkItemTypeBehavior. :param behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param\",\n \"page :type locked: bool :param order: Order in which the page should appear\",\n \"the group should appear in the section. :type order: int :param overridden: A\",\n \"\\\"\\\"\\\"WorkItemBehaviorReference. :param id: :type id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"is contribution or not. :type is_contribution: bool :param label: Label for the field\",\n \":param watermark: Watermark text for the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map =\",\n \"'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'reference_name':\",\n \"hidden or not. :type visible: bool :param watermark: Watermark text for the textbox.\",\n \"self.id = id self.inherited = inherited self.is_contribution = is_contribution self.label = label self.locked\",\n \"__init__(self, behaviors=None, class_=None, color=None, description=None, icon=None, id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None):\",\n \":type field: str :param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'condition_type':\",\n \"reference_name self.type_id = type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param\",\n \"'int'}, 'id': {'key': 'id', 'type': 'str'}, 'inherited': {'key': 'inherited', 'type': 'bool'}, 'is_contribution': {'key':\",\n \"str :param is_disabled: :type is_disabled: bool :param is_system: :type is_system: bool \\\"\\\"\\\" _attribute_map\",\n \"'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None, hidden=None, id=None, name=None,\",\n \"{ 'groups': {'key': 'groups', 'type': '[Group]'}, 'id': {'key': 'id', 'type': 'str'}, 'overridden': {'key':\",\n \"is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param parent_process_type_id: :type parent_process_type_id:\",\n \":param visible: A value indicating if the page should be hidden or not.\",\n \"'str'}, 'is_disabled': {'key': 'isDisabled', 'type': 'bool'}, 'layout': {'key': 'layout', 'type': 'FormLayout'}, 'name': {'key':\",\n \"{'key': 'field', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, condition_type=None,\",\n \"value indicating if the contribution should be show on deleted workItem. :type show_on_deleted_work_item:\",\n \"{'key': 'description', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type':\",\n \"{'key': 'visible', 'type': 'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None,\",\n \"'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id',\",\n \"str :param id: :type id: str :param url: :type url: str \\\"\\\"\\\" _attribute_map\",\n \"self.description = description self.is_default = is_default self.is_enabled = is_enabled self.name = name class\",\n \"behavior: :type behavior: :class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type\",\n \"'type': 'str'}, 'description': {'key': 'description', 'type': 'str'}, 'fields': {'key': 'fields', 'type': '[WorkItemBehaviorField]'}, 'id':\",\n \"list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout. :type system_controls:\",\n \"'[WorkItemTypeBehavior]'}, 'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key':\",\n \"= id self.is_identity = is_identity self.name = name self.type = type self.url =\",\n \"self.name = name self.order = order self.state_category = state_category self.url = url class\",\n \"{ 'condition_type': {'key': 'conditionType', 'type': 'str'}, 'field': {'key': 'field', 'type': 'str'}, 'value': {'key':\",\n \"height: The height for the contribution. :type height: int :param inputs: A dictionary\",\n \"controls. :type height: int :param id: The id for the layout node. :type\",\n \"url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url = url class\",\n \"contribution_id: The id for the contribution. :type contribution_id: str :param height: The height\",\n \"{ 'class_': {'key': 'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key':\",\n \"\\\"\\\"\\\"Section. :param groups: :type groups: list of :class:`Group <work-item-tracking.v4_0.models.Group>` :param id: The id\",\n \"'isEnabled', 'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'}\",\n \"self.name = name self.overriden = overriden self.rank = rank self.url = url class\",\n \"id=None, inherits=None, is_disabled=None, layout=None, name=None, states=None, url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_\",\n \"indicating whether this layout node has been overridden by a child layout. :type\",\n \"'bool'} } def __init__(self, contribution=None, controls=None, height=None, id=None, inherited=None, is_contribution=None, label=None, order=None, overridden=None,\",\n \"id: The id for the layout node. :type id: str :param overridden: A\",\n \"A dictionary holding key value pairs for contribution inputs. :type inputs: dict :param\",\n \"the group. :type controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` :param height: The height for\",\n \"node has been inherited from a parent layout. This is expected to only\",\n \"'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'str'}, 'is_disabled':\",\n \"read_only: bool :param visible: A value indicating if the control should be hidden\",\n \"'type': 'str'}, 'hidden': {'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name':\",\n \"Licensed under the MIT License. See License.txt in the project root for license\",\n \":param page_type: The icon for the page. :type page_type: object :param sections: The\",\n \":param value: :type value: str \\\"\\\"\\\" _attribute_map = { 'condition_type': {'key': 'conditionType', 'type':\",\n \"Headers controls of the layout. :type system_controls: list of :class:`Control <work-item-tracking.v4_0.models.Control>` \\\"\\\"\\\" _attribute_map\",\n \"not. :type is_contribution: bool :param label: Label for the group. :type label: str\",\n \":param height: The height for the contribution. :type height: int :param id: The\",\n \":type class_: object :param color: :type color: str :param description: :type description: str\",\n \"'type': 'bool'}, 'parent_process_type_id': {'key': 'parentProcessTypeId', 'type': 'str'}, 'version': {'key': 'version', 'type': 'str'} }\",\n \"'type': '[ProjectReference]'}, 'properties': {'key': 'properties', 'type': 'ProcessProperties'}, 'reference_name': {'key': 'referenceName', 'type': 'str'}, 'type_id':\",\n \"order self.overridden = overridden self.visible = visible class Page(Model): \\\"\\\"\\\"Page. :param contribution: Contribution\",\n \"{'key': 'targetField', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'} } def __init__(self, action_type=None,\",\n \"class FormLayout(Model): \\\"\\\"\\\"FormLayout. :param extensions: Gets and sets extensions list :type extensions: list\",\n \"Extension(Model): \\\"\\\"\\\"Extension. :param id: :type id: str \\\"\\\"\\\" _attribute_map = { 'id': {'key':\",\n \"{'key': 'referenceName', 'type': 'str'}, 'type_id': {'key': 'typeId', 'type': 'str'} } def __init__(self, description=None,\",\n \"value indicating if the control should be hidden or not. :type visible: bool\",\n \":type inputs: dict :param show_on_deleted_work_item: A value indicating if the contribution should be\",\n \"__init__(self, extensions=None, pages=None, system_controls=None): super(FormLayout, self).__init__() self.extensions = extensions self.pages = pages self.system_controls\",\n \"type_id: str \\\"\\\"\\\" _attribute_map = { 'description': {'key': 'description', 'type': 'str'}, 'name': {'key':\",\n \"parent_process_type_id: :type parent_process_type_id: str :param version: :type version: str \\\"\\\"\\\" _attribute_map = {\",\n \"of :class:`WorkItemStateResultModel <work-item-tracking.v4_0.models.WorkItemStateResultModel>` :param url: :type url: str \\\"\\\"\\\" _attribute_map = { 'behaviors':\",\n \"{'key': 'hidden', 'type': 'bool'}, 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type':\",\n \"'bool'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, behavior=None, is_default=None, url=None): super(WorkItemTypeBehavior,\",\n \"self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id = id\",\n \"height=None, inputs=None, show_on_deleted_work_item=None): super(WitContribution, self).__init__() self.contribution_id = contribution_id self.height = height self.inputs =\",\n \"action_type: :type action_type: str :param target_field: :type target_field: str :param value: :type value:\",\n \"= order self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark =\",\n \"field self.value = value class Section(Model): \\\"\\\"\\\"Section. :param groups: :type groups: list of\",\n \"= sections self.visible = visible class ProcessModel(Model): \\\"\\\"\\\"ProcessModel. :param description: :type description: str\",\n \"show_on_deleted_work_item: A value indicating if the contribution should be show on deleted workItem.\",\n \"'url', 'type': 'str'} } def __init__(self, description=None, id=None, is_identity=None, name=None, type=None, url=None): super(FieldModel,\",\n \"'isIdentity', 'type': 'bool'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'object'},\",\n \"self.inherits = inherits self.is_disabled = is_disabled self.layout = layout self.name = name self.states\",\n \"'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'order': {'key': 'order', 'type': 'int'}, 'overridden':\",\n \"of :class:`Extension <work-item-tracking.v4_0.models.Extension>` :param pages: Top level tabs of the layout. :type pages:\",\n \"'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'}, 'order': {'key': 'order', 'type': 'int'},\",\n \"'class', 'type': 'object'}, 'is_default': {'key': 'isDefault', 'type': 'bool'}, 'is_enabled': {'key': 'isEnabled', 'type': 'bool'},\",\n \"'str'} } def __init__(self, description=None, name=None, projects=None, properties=None, reference_name=None, type_id=None): super(ProcessModel, self).__init__() self.description\",\n \"'type': 'str'} } def __init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description =\",\n \"rank: :type rank: int :param url: :type url: str \\\"\\\"\\\" _attribute_map = {\",\n \"'class_': {'key': 'class', 'type': 'object'}, 'color': {'key': 'color', 'type': 'str'}, 'description': {'key': 'description',\",\n \"the field :type label: str :param metadata: Inner text of the control. :type\",\n \"self.icon = icon self.id = id self.inherits = inherits self.is_disabled = is_disabled self.layout\",\n \"\\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden: bool :param id:\",\n \"dict :param show_on_deleted_work_item: A value indicating if the contribution should be show on\",\n \"self.overridden = overridden self.read_only = read_only self.visible = visible self.watermark = watermark class\",\n \"str :param height: The height for the contribution. :type height: int :param inputs:\",\n \"height: int :param id: The id for the layout node. :type id: str\",\n \"watermark=None): super(Control, self).__init__() self.contribution = contribution self.control_type = control_type self.height = height self.id\",\n \"<work-item-tracking.v4_0.models.WitContribution>` :param controls: Controls to be put in the group. :type controls: list\",\n \"'fields', 'type': '[WorkItemBehaviorField]'}, 'id': {'key': 'id', 'type': 'str'}, 'inherits': {'key': 'inherits', 'type': 'WorkItemBehaviorReference'},\",\n \"{'key': 'actions', 'type': '[RuleActionModel]'}, 'conditions': {'key': 'conditions', 'type': '[RuleConditionModel]'}, 'friendly_name': {'key': 'friendlyName', 'type':\",\n \"'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'is_identity': {'key': 'isIdentity', 'type': 'bool'}, 'name':\",\n \":type pages: list of :class:`Page <work-item-tracking.v4_0.models.Page>` :param system_controls: Headers controls of the layout.\",\n \"} def __init__(self, contribution=None, control_type=None, height=None, id=None, inherited=None, is_contribution=None, label=None, metadata=None, order=None, overridden=None,\",\n \"WorkItemStateResultModel(Model): \\\"\\\"\\\"WorkItemStateResultModel. :param color: :type color: str :param hidden: :type hidden: bool :param\",\n \"bool :param label: The label for the page. :type label: str :param locked:\",\n \"name: :type name: str :param projects: :type projects: list of :class:`ProjectReference <work-item-tracking.v4_0.models.ProjectReference>` :param\",\n \"__init__(self, description=None, id=None, name=None, url=None): super(ProjectReference, self).__init__() self.description = description self.id = id\",\n \":param name: :type name: str :param url: :type url: str \\\"\\\"\\\" _attribute_map =\",\n \"'FormLayout'}, 'name': {'key': 'name', 'type': 'str'}, 'states': {'key': 'states', 'type': '[WorkItemStateResultModel]'}, 'url': {'key':\",\n \"url=None): super(WorkItemTypeModel, self).__init__() self.behaviors = behaviors self.class_ = class_ self.color = color self.description\",\n \":class:`WorkItemBehaviorReference <work-item-tracking.v4_0.models.WorkItemBehaviorReference>` :param is_default: :type is_default: bool :param url: :type url: str \\\"\\\"\\\"\",\n \"A value indicating if the group should be hidden or not. :type visible:\",\n \"'isContribution', 'type': 'bool'}, 'label': {'key': 'label', 'type': 'str'}, 'locked': {'key': 'locked', 'type': 'bool'},\",\n \"is_system=None): super(FieldRuleModel, self).__init__() self.actions = actions self.conditions = conditions self.friendly_name = friendly_name self.id\",\n \"self).__init__() self.groups = groups self.id = id self.overridden = overridden class UpdateProcessModel(Model): \\\"\\\"\\\"UpdateProcessModel.\",\n \"__init__(self, behavior_field_id=None, id=None, url=None): super(WorkItemBehaviorField, self).__init__() self.behavior_field_id = behavior_field_id self.id = id self.url\",\n \":type is_default: bool :param is_enabled: :type is_enabled: bool :param name: :type name: str\",\n \"self.id = id class FieldModel(Model): \\\"\\\"\\\"FieldModel. :param description: :type description: str :param id:\",\n \"is_default self.is_enabled = is_enabled self.parent_process_type_id = parent_process_type_id self.version = version class ProjectReference(Model): \\\"\\\"\\\"ProjectReference.\",\n \"order self.overridden = overridden self.page_type = page_type self.sections = sections self.visible = visible\",\n \"id=None, inherits=None, name=None, overriden=None, rank=None, url=None): super(WorkItemBehavior, self).__init__() self.abstract = abstract self.color =\",\n \"type_id class ProcessProperties(Model): \\\"\\\"\\\"ProcessProperties. :param class_: :type class_: object :param is_default: :type is_default:\",\n \"{'key': 'stateCategory', 'type': 'str'}, 'url': {'key': 'url', 'type': 'str'} } def __init__(self, color=None,\",\n \"for the textbox. :type watermark: str \\\"\\\"\\\" _attribute_map = { 'contribution': {'key': 'contribution',\",\n \"Type of the control. :type control_type: str :param height: Height of the control,\",\n \"class_: object :param is_default: :type is_default: bool :param is_enabled: :type is_enabled: bool :param\",\n \"readonly. :type read_only: bool :param visible: A value indicating if the control should\",\n \"def __init__(self, groups=None, id=None, overridden=None): super(Section, self).__init__() self.groups = groups self.id = id\",\n \"is_contribution self.label = label self.metadata = metadata self.order = order self.overridden = overridden\"\n]","isConversational":false}}},{"rowIdx":297,"cells":{"ngram":{"kind":"list like","value":["from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\"","= self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in movies:","@abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids with data \"\"\" return class","class ids with metadata, return redis pipeline that must be executed \"\"\" if","obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for","movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres'","in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class","fields=None, from_index=False): \"\"\" hydrates class ids with metadata, return redis pipeline that must","import abc from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def","super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None,","import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection","fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx","abc from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self):","be executed \"\"\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies","if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for","values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres']","None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies))","key, value) def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class ids with metadata,","value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates","Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key,","'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year'])","<reponame>ziggyzacks/pyrecs import abc from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod","redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant","pipeline that must be executed \"\"\" if fields is None: fields = Movies.DEFAULT_FIELDS","obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response","fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class ids with metadata, return redis pipeline","from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie","= [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields,","ids with metadata, return redis pipeline that must be executed \"\"\" if fields","with data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def","LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value","fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response","\"\"\" redis connection \"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids","'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key,","__metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod def","movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj:","@abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\"","obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return","hydrates class ids with metadata, return redis pipeline that must be executed \"\"\"","__init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def fetch(self,","return redis pipeline that must be executed \"\"\" if fields is None: fields","movies)) response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj","int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for m in movies))","= ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items():","values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year']","ids with data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres']","for idx in movies)) response = [] for movie in movies: values =","idx in movies)) response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie),","DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in","\"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs):","= self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] =","for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if","self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in movies: values","in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in","relevant ids with data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year',","if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for","'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return","= obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def","value) def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class ids with metadata, return","if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] =","def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def","[] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values))","class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\" return","fetch(self, ids): \"\"\" hydrate relevant ids with data \"\"\" return class Movies(Reponse, LogMixin):","= dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in","['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self,","setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class ids with","connection \"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids with data","\"\"\" hydrates class ids with metadata, return redis pipeline that must be executed","**kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies,","redis pipeline that must be executed \"\"\" if fields is None: fields =","return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids with data \"\"\" return","obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year'","dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj:","metadata, return redis pipeline that must be executed \"\"\" if fields is None:","movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in","utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis","must be executed \"\"\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index:","self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',')","\"\"\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx)","class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for","= Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response =","key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \"\"\"","in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj)","ids): \"\"\" hydrate relevant ids with data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS","\"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids with data \"\"\"","that must be executed \"\"\" if fields is None: fields = Movies.DEFAULT_FIELDS if","if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies):","is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in","= int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for m in","def redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate","Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = []","executed \"\"\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies =","return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__()","obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for m","hydrate relevant ids with data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title',","for key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False):","response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj =","def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class ids with metadata, return redis","def fetch(self, ids): \"\"\" hydrate relevant ids with data \"\"\" return class Movies(Reponse,","in movies)) response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields)","with metadata, return redis pipeline that must be executed \"\"\" if fields is","abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod def fetch(self, ids):","'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value)","kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \"\"\" hydrates class ids","\"\"\" hydrate relevant ids with data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS =","obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self,","fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if","redis connection \"\"\" return @abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids with","movies, fields=None, from_index=False): \"\"\" hydrates class ids with metadata, return redis pipeline that","in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m)","from_index=False): \"\"\" hydrates class ids with metadata, return redis pipeline that must be","Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod","LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\"","data \"\"\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self,","= abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\" redis connection \"\"\" return @abc.abstractmethod def fetch(self,"],"string":"[\n \"from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\"\",\n \"= self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in movies:\",\n \"@abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\" return class\",\n \"class ids with metadata, return redis pipeline that must be executed \\\"\\\"\\\" if\",\n \"obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for\",\n \"movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres'\",\n \"in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class\",\n \"fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with metadata, return redis pipeline that must\",\n \"import abc from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def\",\n \"super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None,\",\n \"import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection\",\n \"fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx\",\n \"abc from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self):\",\n \"be executed \\\"\\\"\\\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies\",\n \"if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for\",\n \"values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres']\",\n \"None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies))\",\n \"key, value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with metadata,\",\n \"value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates\",\n \"Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key,\",\n \"'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year'])\",\n \"<reponame>ziggyzacks/pyrecs import abc from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod\",\n \"redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant\",\n \"pipeline that must be executed \\\"\\\"\\\" if fields is None: fields = Movies.DEFAULT_FIELDS\",\n \"obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response\",\n \"fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with metadata, return redis pipeline\",\n \"from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie\",\n \"= [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields,\",\n \"ids with metadata, return redis pipeline that must be executed \\\"\\\"\\\" if fields\",\n \"with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def\",\n \"LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value\",\n \"fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response\",\n \"\\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids\",\n \"'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key,\",\n \"__metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def\",\n \"movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj:\",\n \"@abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\"\",\n \"obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return\",\n \"hydrates class ids with metadata, return redis pipeline that must be executed \\\"\\\"\\\"\",\n \"__init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def fetch(self,\",\n \"return redis pipeline that must be executed \\\"\\\"\\\" if fields is None: fields\",\n \"movies)) response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj\",\n \"int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for m in movies))\",\n \"= ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items():\",\n \"values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year']\",\n \"ids with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres']\",\n \"for idx in movies)) response = [] for movie in movies: values =\",\n \"idx in movies)) response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie),\",\n \"DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in\",\n \"\\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs):\",\n \"= self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] =\",\n \"for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if\",\n \"self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in movies: values\",\n \"in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in\",\n \"relevant ids with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year',\",\n \"if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for\",\n \"'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return\",\n \"= obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def\",\n \"value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with metadata, return\",\n \"if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] =\",\n \"def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def\",\n \"[] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values))\",\n \"class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return\",\n \"fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin):\",\n \"= dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in\",\n \"['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self,\",\n \"setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with\",\n \"connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with data\",\n \"\\\"\\\"\\\" hydrates class ids with metadata, return redis pipeline that must be executed\",\n \"**kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies,\",\n \"redis pipeline that must be executed \\\"\\\"\\\" if fields is None: fields =\",\n \"return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\" return\",\n \"obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year'\",\n \"dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj:\",\n \"metadata, return redis pipeline that must be executed \\\"\\\"\\\" if fields is None:\",\n \"movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in\",\n \"utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis\",\n \"must be executed \\\"\\\"\\\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index:\",\n \"self.redis.hmget('movie:{}'.format(movie), fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',')\",\n \"\\\"\\\"\\\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx)\",\n \"class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__() for\",\n \"= Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response =\",\n \"key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\"\",\n \"in obj: obj['genres'] = obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj)\",\n \"ids): \\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS\",\n \"\\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\"\",\n \"that must be executed \\\"\\\"\\\" if fields is None: fields = Movies.DEFAULT_FIELDS if\",\n \"if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies):\",\n \"is None: fields = Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in\",\n \"= int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for m in\",\n \"def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate\",\n \"Movies.DEFAULT_FIELDS if from_index: movies = self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = []\",\n \"executed \\\"\\\"\\\" if fields is None: fields = Movies.DEFAULT_FIELDS if from_index: movies =\",\n \"return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self, **kwargs): super().__init__()\",\n \"obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m) for m\",\n \"hydrate relevant ids with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title',\",\n \"for key, value in kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False):\",\n \"response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields) obj =\",\n \"def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with metadata, return redis\",\n \"def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\" return class Movies(Reponse,\",\n \"in movies)) response = [] for movie in movies: values = self.redis.hmget('movie:{}'.format(movie), fields)\",\n \"with metadata, return redis pipeline that must be executed \\\"\\\"\\\" if fields is\",\n \"abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids):\",\n \"'genres'] def __init__(self, **kwargs): super().__init__() for key, value in kwargs.items(): setattr(self, key, value)\",\n \"kwargs.items(): setattr(self, key, value) def fetch(self, movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids\",\n \"\\\"\\\"\\\" hydrate relevant ids with data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS =\",\n \"obj['genres'].split(',') if 'year' in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self,\",\n \"fields) obj = dict(zip(fields, values)) if 'genres' in obj: obj['genres'] = obj['genres'].split(',') if\",\n \"redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self, ids): \\\"\\\"\\\" hydrate relevant ids with\",\n \"movies, fields=None, from_index=False): \\\"\\\"\\\" hydrates class ids with metadata, return redis pipeline that\",\n \"in obj: obj['year'] = int(obj['year']) response.append(obj) return response def movie_to_index(self, movies): return self.redis.mget(('index:movie:{}'.format(m)\",\n \"from_index=False): \\\"\\\"\\\" hydrates class ids with metadata, return redis pipeline that must be\",\n \"Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod\",\n \"LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\"\",\n \"data \\\"\\\"\\\" return class Movies(Reponse, LogMixin): DEFAULT_FIELDS = ['title', 'year', 'genres'] def __init__(self,\",\n \"= abc.ABCMeta @abc.abstractmethod def redis(self): \\\"\\\"\\\" redis connection \\\"\\\"\\\" return @abc.abstractmethod def fetch(self,\"\n]","isConversational":false}}},{"rowIdx":298,"cells":{"ngram":{"kind":"list like","value":["# This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility,","kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name","name + \"_pb\" py_grpc_compile( name = name_pb, deps = deps, visibility = visibility,",") native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # fixme","\"py_grpc_compile\") load(\"@grpc_py_deps//:requirements.bzl\", \"all_requirements\") def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose =","verbose, ) native.py_library( name = name, srcs = [name_pb], deps = all_requirements, #","[name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\")","deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb],","py_grpc_compile( name = name_pb, deps = deps, visibility = visibility, verbose = verbose,","= name, srcs = [name_pb], deps = all_requirements, # fixme don't need grpc","= verbose, ) native.py_library( name = name, srcs = [name_pb], deps = all_requirements,","= [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports","\"_pb\" py_grpc_compile( name = name_pb, deps = deps, visibility = visibility, verbose =","[name_pb], deps = all_requirements, # fixme don't need grpc here # This magically","name + \"_pb\" py_proto_compile( name = name_pb, deps = deps, visibility = visibility,","= kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\"","= kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb =","This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, )","= kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile( name = name_pb, deps =","= name + \"_pb\" py_grpc_compile( name = name_pb, deps = deps, visibility =","all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility =","= name_pb, deps = deps, visibility = visibility, verbose = verbose, ) native.py_library(","native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # This magically","visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose","py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\")","= kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile( name =","kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile( name = name_pb, deps = deps,","kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile(","kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile(","name_pb = name + \"_pb\" py_grpc_compile( name = name_pb, deps = deps, visibility","name_pb = name + \"_pb\" py_proto_compile( name = name_pb, deps = deps, visibility","visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\")","imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps","= kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile( name =","= name, srcs = [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb}",") native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # This","verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile( name","visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile( name = name_pb, deps","visibility = visibility, verbose = verbose, ) native.py_library( name = name, srcs =","visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile( name = name_pb, deps","= visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose =","= [name_pb], deps = all_requirements, # fixme don't need grpc here # This","def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility =","\"py_proto_compile\", \"py_grpc_compile\") load(\"@grpc_py_deps//:requirements.bzl\", \"all_requirements\") def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose","verbose = verbose, ) native.py_library( name = name, srcs = [name_pb], deps =","to PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name =","adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs):","kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile( name = name_pb,","= deps, visibility = visibility, verbose = verbose, ) native.py_library( name = name,","[name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports =","= name + \"_pb\" py_proto_compile( name = name_pb, deps = deps, visibility =","deps = deps, visibility = visibility, verbose = verbose, ) native.py_library( name =","# fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH","deps, visibility = visibility, verbose = verbose, ) native.py_library( name = name, srcs","+ \"_pb\" py_proto_compile( name = name_pb, deps = deps, visibility = visibility, verbose","py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\")","name_pb, deps = deps, visibility = visibility, verbose = verbose, ) native.py_library( name","= [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps =","= all_requirements, # fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb}","REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name","name = name, srcs = [name_pb], deps = all_requirements, # fixme don't need","visibility, verbose = verbose, ) native.py_library( name = name, srcs = [name_pb], deps","verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile( name","kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile( name = name_pb,","load(\"//python:compile.bzl\", \"py_proto_compile\", \"py_grpc_compile\") load(\"@grpc_py_deps//:requirements.bzl\", \"all_requirements\") def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\")","py_proto_compile( name = name_pb, deps = deps, visibility = visibility, verbose = verbose,","deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name +","need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb],","def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility =","deps = all_requirements, # fixme don't need grpc here # This magically adds","name = name_pb, deps = deps, visibility = visibility, verbose = verbose, )","+ \"_pb\" py_grpc_compile( name = name_pb, deps = deps, visibility = visibility, verbose","\"_pb\" py_proto_compile( name = name_pb, deps = deps, visibility = visibility, verbose =","grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility","= all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility","load(\"@grpc_py_deps//:requirements.bzl\", \"all_requirements\") def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\")","name, srcs = [name_pb], deps = all_requirements, # fixme don't need grpc here","name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb","here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility =","= visibility, verbose = verbose, ) native.py_library( name = name, srcs = [name_pb],","srcs = [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH","all_requirements, # fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to","= kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_grpc_compile( name = name_pb, deps =","<gh_stars>0 load(\"//python:compile.bzl\", \"py_proto_compile\", \"py_grpc_compile\") load(\"@grpc_py_deps//:requirements.bzl\", \"all_requirements\") def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps =","srcs = [name_pb], deps = all_requirements, # fixme don't need grpc here #","PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\"name\")","kwargs.get(\"visibility\") name_pb = name + \"_pb\" py_proto_compile( name = name_pb, deps = deps,","fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports","magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, ) def","name, srcs = [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to","\"all_requirements\") def py_proto_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility",") def py_grpc_library(**kwargs): name = kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility","name = name, srcs = [name_pb], deps = all_requirements, # This magically adds","native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # fixme don't","don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports ="],"string":"[\n \"# This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility,\",\n \"kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name\",\n \"name + \\\"_pb\\\" py_grpc_compile( name = name_pb, deps = deps, visibility = visibility,\",\n \") native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # fixme\",\n \"\\\"py_grpc_compile\\\") load(\\\"@grpc_py_deps//:requirements.bzl\\\", \\\"all_requirements\\\") def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose =\",\n \"verbose, ) native.py_library( name = name, srcs = [name_pb], deps = all_requirements, #\",\n \"[name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\")\",\n \"deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb],\",\n \"py_grpc_compile( name = name_pb, deps = deps, visibility = visibility, verbose = verbose,\",\n \"= name, srcs = [name_pb], deps = all_requirements, # fixme don't need grpc\",\n \"= verbose, ) native.py_library( name = name, srcs = [name_pb], deps = all_requirements,\",\n \"= [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports\",\n \"\\\"_pb\\\" py_grpc_compile( name = name_pb, deps = deps, visibility = visibility, verbose =\",\n \"[name_pb], deps = all_requirements, # fixme don't need grpc here # This magically\",\n \"name + \\\"_pb\\\" py_proto_compile( name = name_pb, deps = deps, visibility = visibility,\",\n \"= kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\"\",\n \"= kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb =\",\n \"This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, )\",\n \"= kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile( name = name_pb, deps =\",\n \"= name + \\\"_pb\\\" py_grpc_compile( name = name_pb, deps = deps, visibility =\",\n \"all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility =\",\n \"= name_pb, deps = deps, visibility = visibility, verbose = verbose, ) native.py_library(\",\n \"native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # This magically\",\n \"visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose\",\n \"py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\")\",\n \"= kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile( name =\",\n \"kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile( name = name_pb, deps = deps,\",\n \"kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile(\",\n \"kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile(\",\n \"name_pb = name + \\\"_pb\\\" py_grpc_compile( name = name_pb, deps = deps, visibility\",\n \"name_pb = name + \\\"_pb\\\" py_proto_compile( name = name_pb, deps = deps, visibility\",\n \"visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\")\",\n \"imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps\",\n \"= kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile( name =\",\n \"= name, srcs = [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb}\",\n \") native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # This\",\n \"verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile( name\",\n \"visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile( name = name_pb, deps\",\n \"visibility = visibility, verbose = verbose, ) native.py_library( name = name, srcs =\",\n \"visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile( name = name_pb, deps\",\n \"= visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose =\",\n \"= [name_pb], deps = all_requirements, # fixme don't need grpc here # This\",\n \"def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility =\",\n \"\\\"py_proto_compile\\\", \\\"py_grpc_compile\\\") load(\\\"@grpc_py_deps//:requirements.bzl\\\", \\\"all_requirements\\\") def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose\",\n \"verbose = verbose, ) native.py_library( name = name, srcs = [name_pb], deps =\",\n \"to PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name =\",\n \"adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs):\",\n \"kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile( name = name_pb,\",\n \"= deps, visibility = visibility, verbose = verbose, ) native.py_library( name = name,\",\n \"[name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports =\",\n \"= name + \\\"_pb\\\" py_proto_compile( name = name_pb, deps = deps, visibility =\",\n \"deps = deps, visibility = visibility, verbose = verbose, ) native.py_library( name =\",\n \"# fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH\",\n \"deps, visibility = visibility, verbose = verbose, ) native.py_library( name = name, srcs\",\n \"+ \\\"_pb\\\" py_proto_compile( name = name_pb, deps = deps, visibility = visibility, verbose\",\n \"py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\")\",\n \"name_pb, deps = deps, visibility = visibility, verbose = verbose, ) native.py_library( name\",\n \"= [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps =\",\n \"= all_requirements, # fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb}\",\n \"REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name\",\n \"name = name, srcs = [name_pb], deps = all_requirements, # fixme don't need\",\n \"visibility, verbose = verbose, ) native.py_library( name = name, srcs = [name_pb], deps\",\n \"verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile( name\",\n \"kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile( name = name_pb,\",\n \"load(\\\"//python:compile.bzl\\\", \\\"py_proto_compile\\\", \\\"py_grpc_compile\\\") load(\\\"@grpc_py_deps//:requirements.bzl\\\", \\\"all_requirements\\\") def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\")\",\n \"py_proto_compile( name = name_pb, deps = deps, visibility = visibility, verbose = verbose,\",\n \"deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb = name +\",\n \"need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb],\",\n \"def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility =\",\n \"deps = all_requirements, # fixme don't need grpc here # This magically adds\",\n \"name = name_pb, deps = deps, visibility = visibility, verbose = verbose, )\",\n \"+ \\\"_pb\\\" py_grpc_compile( name = name_pb, deps = deps, visibility = visibility, verbose\",\n \"\\\"_pb\\\" py_proto_compile( name = name_pb, deps = deps, visibility = visibility, verbose =\",\n \"grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility\",\n \"= all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility\",\n \"load(\\\"@grpc_py_deps//:requirements.bzl\\\", \\\"all_requirements\\\") def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\")\",\n \"name, srcs = [name_pb], deps = all_requirements, # fixme don't need grpc here\",\n \"name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility = kwargs.get(\\\"visibility\\\") name_pb\",\n \"here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility =\",\n \"= visibility, verbose = verbose, ) native.py_library( name = name, srcs = [name_pb],\",\n \"srcs = [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH\",\n \"all_requirements, # fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to\",\n \"= kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_grpc_compile( name = name_pb, deps =\",\n \"<gh_stars>0 load(\\\"//python:compile.bzl\\\", \\\"py_proto_compile\\\", \\\"py_grpc_compile\\\") load(\\\"@grpc_py_deps//:requirements.bzl\\\", \\\"all_requirements\\\") def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps =\",\n \"srcs = [name_pb], deps = all_requirements, # fixme don't need grpc here #\",\n \"PYTHONPATH imports = [name_pb], visibility = visibility, ) def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\")\",\n \"kwargs.get(\\\"visibility\\\") name_pb = name + \\\"_pb\\\" py_proto_compile( name = name_pb, deps = deps,\",\n \"fixme don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports\",\n \"magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility, ) def\",\n \"name, srcs = [name_pb], deps = all_requirements, # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to\",\n \"\\\"all_requirements\\\") def py_proto_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility\",\n \") def py_grpc_library(**kwargs): name = kwargs.get(\\\"name\\\") deps = kwargs.get(\\\"deps\\\") verbose = kwargs.get(\\\"verbose\\\") visibility\",\n \"name = name, srcs = [name_pb], deps = all_requirements, # This magically adds\",\n \"native.py_library( name = name, srcs = [name_pb], deps = all_requirements, # fixme don't\",\n \"don't need grpc here # This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports =\"\n]","isConversational":false}}},{"rowIdx":299,"cells":{"ngram":{"kind":"list like","value":["the copyright holders nor the names of its # contributors may be used","# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A","machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type","ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT #","# Copyright (c) 1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard","# documentation and/or other materials provided with the distribution; # neither the name","the above copyright # notice, this list of conditions and the following disclaimer;","All rights reserved. # # Redistribution and use in source and binary forms,","software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY","# this software without specific prior written permission. # # THIS SOFTWARE IS","\"external\" in self: return set() if parent: ident = \"%s_%s\" % (parent, self.type_ast.ident)","Add all of the fields of the type to it for field in","1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company #","disclaimer; # redistributions in binary form must reproduce the above copyright # notice,","def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts","\"%s_%s\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\"","redistributions of source code must retain the above copyright # notice, this list","= self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def generate(self): ident =","conditions and the following disclaimer in the # documentation and/or other materials provided","field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return","ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type =","the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type)","IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY","self: return set() if parent: ident = \"%s_%s\" % (parent, self.type_ast.ident) else: ident","this list of conditions and the following disclaimer; # redistributions in binary form","PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR","BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES","THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE","str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident,","notice, this list of conditions and the following disclaimer in the # documentation","import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs,","this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED","TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR","without # modification, are permitted provided that the following conditions are # met:","all of the fields of the type to it for field in self.field_asts:","% (self.type_ast) def files(self, parent=None): if \"external\" in self: return set() if parent:","(c) 2009 The Hewlett-Packard Development Company # All rights reserved. # # Redistribution","and/or other materials provided with the distribution; # neither the name of the","ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED","NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,","with or without # modification, are permitted provided that the following conditions are","def files(self, parent=None): if \"external\" in self: return set() if parent: ident =","# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY #","IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED.","self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of","BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN","% ident, \"%s.cc\" % ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine","# \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT #","self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def","from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST,","endorse or promote products derived from # this software without specific prior written","pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self):","A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER","field_asts def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None): if \"external\"","if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the","__repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None): if \"external\" in self:","WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF","DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT #","NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR #","rights reserved. # # Redistribution and use in source and binary forms, with","OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER","permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS","OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE,","THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type","THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF","OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR","or without # modification, are permitted provided that the following conditions are #","are permitted provided that the following conditions are # met: redistributions of source","# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, #","LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE)","that the following conditions are # met: redistributions of source code must retain","ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type","SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND","Hewlett-Packard Development Company # All rights reserved. # # Redistribution and use in","with the distribution; # neither the name of the copyright holders nor the","SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,","NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY","COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES,","new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() #","FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT","without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE","provided that the following conditions are # met: redistributions of source code must","code must retain the above copyright # notice, this list of conditions and","# notice, this list of conditions and the following disclaimer in the #","ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT","SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED","Copyright (c) 1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development","from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc,","OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR","= type_ast self.field_asts = field_asts def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def","SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS","DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY","list of conditions and the following disclaimer; # redistributions in binary form must","machine = self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident, self.location,","set() if parent: ident = \"%s_%s\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident","THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST","= str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type = Type(self.symtab,","PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY,","NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF","AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT","and use in source and binary forms, with or without # modification, are","Development Company # All rights reserved. # # Redistribution and use in source","THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED","CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY","EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES","other materials provided with the distribution; # neither the name of the copyright","this list of conditions and the following disclaimer in the # documentation and/or","<NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company # All rights reserved.","SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import","return set() if parent: ident = \"%s_%s\" % (parent, self.type_ast.ident) else: ident =","distribution; # neither the name of the copyright holders nor the names of","self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type to it","pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \"[TypeDecl: %r]\" %","of its # contributors may be used to endorse or promote products derived","its # contributors may be used to endorse or promote products derived from","(INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS","disclaimer in the # documentation and/or other materials provided with the distribution; #","LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA,","OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE","OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS","notice, this list of conditions and the following disclaimer; # redistributions in binary","WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING","contributors may be used to endorse or promote products derived from # this","IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from","must retain the above copyright # notice, this list of conditions and the","ident = \"%s_%s\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\" %","# notice, this list of conditions and the following disclaimer; # redistributions in","type_ast self.field_asts = field_asts def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def files(self,","% (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" %","redistributions in binary form must reproduce the above copyright # notice, this list","Redistribution and use in source and binary forms, with or without # modification,","source and binary forms, with or without # modification, are permitted provided that","above copyright # notice, this list of conditions and the following disclaimer in","BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF","THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\"","slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast,","binary form must reproduce the above copyright # notice, this list of conditions","(c) 1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company","form must reproduce the above copyright # notice, this list of conditions and","and the following disclaimer; # redistributions in binary form must reproduce the above","<NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company # All","STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY","slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts","derived from # this software without specific prior written permission. # # THIS","WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN","IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR","= self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs,","in self: return set() if parent: ident = \"%s_%s\" % (parent, self.type_ast.ident) else:","# contributors may be used to endorse or promote products derived from #","the above copyright # notice, this list of conditions and the following disclaimer","PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS","% ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the","EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,","import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs)","Copyright (c) 2009 The Hewlett-Packard Development Company # All rights reserved. # #","generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type","following disclaimer; # redistributions in binary form must reproduce the above copyright #","and the following disclaimer in the # documentation and/or other materials provided with","self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields","forms, with or without # modification, are permitted provided that the following conditions","of the fields of the type to it for field in self.field_asts: field.generate(new_type)","are # met: redistributions of source code must retain the above copyright #","source code must retain the above copyright # notice, this list of conditions","FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT","CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR","in source and binary forms, with or without # modification, are permitted provided","type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame()","provided with the distribution; # neither the name of the copyright holders nor","IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF","return \"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None): if \"external\" in self: return","class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast =","# # Redistribution and use in source and binary forms, with or without","AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR","SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def","= field_asts def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None): if","OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER","used to endorse or promote products derived from # this software without specific","IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN","BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR","promote products derived from # this software without specific prior written permission. #","COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, #","prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS","ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT","return set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def generate(self): ident = str(self.type_ast) machine","the distribution; # neither the name of the copyright holders nor the names","# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE","(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE #","HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT","OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from","AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE","if parent: ident = \"%s_%s\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return","following disclaimer in the # documentation and/or other materials provided with the distribution;","self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def generate(self): ident = str(self.type_ast)","the fields of the type to it for field in self.field_asts: field.generate(new_type) self.symtab.popFrame()","IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO,","use in source and binary forms, with or without # modification, are permitted","in binary form must reproduce the above copyright # notice, this list of","OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF","# All rights reserved. # # Redistribution and use in source and binary","above copyright # notice, this list of conditions and the following disclaimer; #","CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,","machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type to","to endorse or promote products derived from # this software without specific prior","# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS","ident, \"%s.cc\" % ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine #","if \"external\" in self: return set() if parent: ident = \"%s_%s\" % (parent,","of conditions and the following disclaimer; # redistributions in binary form must reproduce","name of the copyright holders nor the names of its # contributors may","# neither the name of the copyright holders nor the names of its","# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL,","\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED","copyright holders nor the names of its # contributors may be used to","DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts):","the following disclaimer; # redistributions in binary form must reproduce the above copyright","ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new","new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type)","HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,","holders nor the names of its # contributors may be used to endorse","products derived from # this software without specific prior written permission. # #","USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY","# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING","documentation and/or other materials provided with the distribution; # neither the name of","# redistributions in binary form must reproduce the above copyright # notice, this","from # this software without specific prior written permission. # # THIS SOFTWARE","slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc,","Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all","type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def","parent: ident = \"%s_%s\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\"","# Copyright (c) 2009 The Hewlett-Packard Development Company # All rights reserved. #","LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND","be used to endorse or promote products derived from # this software without","conditions are # met: redistributions of source code must retain the above copyright","OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO","%r]\" % (self.type_ast) def files(self, parent=None): if \"external\" in self: return set() if","USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH","reproduce the above copyright # notice, this list of conditions and the following","OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST):","BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR","OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS","and binary forms, with or without # modification, are permitted provided that the","names of its # contributors may be used to endorse or promote products","AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL","# Add all of the fields of the type to it for field","the following conditions are # met: redistributions of source code must retain the","POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class","conditions and the following disclaimer; # redistributions in binary form must reproduce the","neither the name of the copyright holders nor the names of its #","IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \"AS IS\" AND ANY","(self.type_ast) def files(self, parent=None): if \"external\" in self: return set() if parent: ident","modification, are permitted provided that the following conditions are # met: redistributions of","TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE","of conditions and the following disclaimer in the # documentation and/or other materials","WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND","# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT #","# met: redistributions of source code must retain the above copyright # notice,","ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED","ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN","EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST","OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR","FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE","INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT,","\"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None): if \"external\" in self: return set()","CONTRIBUTORS # \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT","OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF","LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR","OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF","THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE","# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT","self.field_asts = field_asts def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None):","the following disclaimer in the # documentation and/or other materials provided with the","must reproduce the above copyright # notice, this list of conditions and the","EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE","TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast","DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE","else: ident = self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def generate(self):","The Hewlett-Packard Development Company # All rights reserved. # # Redistribution and use","PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS","CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL","ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE","DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self,","in the # documentation and/or other materials provided with the distribution; # neither","set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def generate(self): ident = str(self.type_ast) machine =","# Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if","permitted provided that the following conditions are # met: redistributions of source code","the name of the copyright holders nor the names of its # contributors","\"%s.cc\" % ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make","materials provided with the distribution; # neither the name of the copyright holders","MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT","parent=None): if \"external\" in self: return set() if parent: ident = \"%s_%s\" %","= Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add","2009 The Hewlett-Packard Development Company # All rights reserved. # # Redistribution and","list of conditions and the following disclaimer in the # documentation and/or other","(parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" % ident))","the names of its # contributors may be used to endorse or promote","retain the above copyright # notice, this list of conditions and the following","super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \"[TypeDecl:","the # documentation and/or other materials provided with the distribution; # neither the","reserved. # # Redistribution and use in source and binary forms, with or","# Redistribution and use in source and binary forms, with or without #","self.symtab.pushFrame() # Add all of the fields of the type to it for","def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new type","nor the names of its # contributors may be used to endorse or","DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;","SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF","__init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts =","self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the","PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS;","Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine:","OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON","LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,","self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine)","TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE","files(self, parent=None): if \"external\" in self: return set() if parent: ident = \"%s_%s\"","binary forms, with or without # modification, are permitted provided that the following","of source code must retain the above copyright # notice, this list of","following conditions are # met: redistributions of source code must retain the above","OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY,","def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast) def files(self, parent=None): if \"external\" in","may be used to endorse or promote products derived from # this software","Company # All rights reserved. # # Redistribution and use in source and","met: redistributions of source code must retain the above copyright # notice, this","and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company # All rights","# modification, are permitted provided that the following conditions are # met: redistributions","# # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS #","OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import","copyright # notice, this list of conditions and the following disclaimer; # redistributions","THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,","INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED","Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast","= \"%s_%s\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\"%s.hh\" % ident,","GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION)","LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT","OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY","INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS","self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \"[TypeDecl: %r]\"","self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \"[TypeDecl: %r]\" % (self.type_ast)","# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.","ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of","of the copyright holders nor the names of its # contributors may be","written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND","copyright # notice, this list of conditions and the following disclaimer in the","or promote products derived from # this software without specific prior written permission.","INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO,","specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT","ident = self.type_ast.ident return set((\"%s.hh\" % ident, \"%s.cc\" % ident)) def generate(self): ident"],"string":"[\n \"the copyright holders nor the names of its # contributors may be used\",\n \"# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A\",\n \"machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type\",\n \"ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT #\",\n \"# Copyright (c) 1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard\",\n \"# documentation and/or other materials provided with the distribution; # neither the name\",\n \"the above copyright # notice, this list of conditions and the following disclaimer;\",\n \"All rights reserved. # # Redistribution and use in source and binary forms,\",\n \"software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY\",\n \"# this software without specific prior written permission. # # THIS SOFTWARE IS\",\n \"\\\"external\\\" in self: return set() if parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident)\",\n \"Add all of the fields of the type to it for field in\",\n \"1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company #\",\n \"disclaimer; # redistributions in binary form must reproduce the above copyright # notice,\",\n \"def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts\",\n \"\\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\"\",\n \"redistributions of source code must retain the above copyright # notice, this list\",\n \"= self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def generate(self): ident =\",\n \"conditions and the following disclaimer in the # documentation and/or other materials provided\",\n \"field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return\",\n \"ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type =\",\n \"the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type)\",\n \"IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY\",\n \"self: return set() if parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident\",\n \"this list of conditions and the following disclaimer; # redistributions in binary form\",\n \"PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR\",\n \"BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\",\n \"THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE\",\n \"str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident,\",\n \"notice, this list of conditions and the following disclaimer in the # documentation\",\n \"import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs,\",\n \"this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED\",\n \"TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR\",\n \"without # modification, are permitted provided that the following conditions are # met:\",\n \"all of the fields of the type to it for field in self.field_asts:\",\n \"% (self.type_ast) def files(self, parent=None): if \\\"external\\\" in self: return set() if parent:\",\n \"(c) 2009 The Hewlett-Packard Development Company # All rights reserved. # # Redistribution\",\n \"and/or other materials provided with the distribution; # neither the name of the\",\n \"ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED\",\n \"NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\",\n \"with or without # modification, are permitted provided that the following conditions are\",\n \"def files(self, parent=None): if \\\"external\\\" in self: return set() if parent: ident =\",\n \"# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY #\",\n \"IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED.\",\n \"self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of\",\n \"BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN\",\n \"% ident, \\\"%s.cc\\\" % ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine\",\n \"# \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT #\",\n \"self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def\",\n \"from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST,\",\n \"endorse or promote products derived from # this software without specific prior written\",\n \"pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self):\",\n \"A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER\",\n \"field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None): if \\\"external\\\"\",\n \"if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the\",\n \"__repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None): if \\\"external\\\" in self:\",\n \"WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF\",\n \"DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT #\",\n \"NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR #\",\n \"rights reserved. # # Redistribution and use in source and binary forms, with\",\n \"OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER\",\n \"permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\",\n \"OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE,\",\n \"THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type\",\n \"THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\",\n \"OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR\",\n \"or without # modification, are permitted provided that the following conditions are #\",\n \"are permitted provided that the following conditions are # met: redistributions of source\",\n \"# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, #\",\n \"LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE)\",\n \"that the following conditions are # met: redistributions of source code must retain\",\n \"ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type\",\n \"SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND\",\n \"Hewlett-Packard Development Company # All rights reserved. # # Redistribution and use in\",\n \"with the distribution; # neither the name of the copyright holders nor the\",\n \"SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\",\n \"NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY\",\n \"COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES,\",\n \"new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() #\",\n \"FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\",\n \"without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE\",\n \"provided that the following conditions are # met: redistributions of source code must\",\n \"code must retain the above copyright # notice, this list of conditions and\",\n \"# notice, this list of conditions and the following disclaimer in the #\",\n \"ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\",\n \"SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED\",\n \"Copyright (c) 1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development\",\n \"from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc,\",\n \"OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR\",\n \"= type_ast self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def\",\n \"SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS\",\n \"DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY\",\n \"list of conditions and the following disclaimer; # redistributions in binary form must\",\n \"machine = self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident, self.location,\",\n \"set() if parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident\",\n \"THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST\",\n \"= str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type = Type(self.symtab,\",\n \"PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY,\",\n \"NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF\",\n \"AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT\",\n \"and use in source and binary forms, with or without # modification, are\",\n \"Development Company # All rights reserved. # # Redistribution and use in source\",\n \"THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED\",\n \"CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY\",\n \"EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES\",\n \"other materials provided with the distribution; # neither the name of the copyright\",\n \"this list of conditions and the following disclaimer in the # documentation and/or\",\n \"<NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company # All rights reserved.\",\n \"SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import\",\n \"return set() if parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident =\",\n \"distribution; # neither the name of the copyright holders nor the names of\",\n \"self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type to it\",\n \"pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" %\",\n \"of its # contributors may be used to endorse or promote products derived\",\n \"its # contributors may be used to endorse or promote products derived from\",\n \"(INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS\",\n \"disclaimer in the # documentation and/or other materials provided with the distribution; #\",\n \"LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA,\",\n \"OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE\",\n \"OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS\",\n \"notice, this list of conditions and the following disclaimer; # redistributions in binary\",\n \"WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\",\n \"contributors may be used to endorse or promote products derived from # this\",\n \"IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from\",\n \"must retain the above copyright # notice, this list of conditions and the\",\n \"ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" %\",\n \"# notice, this list of conditions and the following disclaimer; # redistributions in\",\n \"type_ast self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self,\",\n \"% (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" %\",\n \"redistributions in binary form must reproduce the above copyright # notice, this list\",\n \"Redistribution and use in source and binary forms, with or without # modification,\",\n \"source and binary forms, with or without # modification, are permitted provided that\",\n \"above copyright # notice, this list of conditions and the following disclaimer in\",\n \"BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF\",\n \"THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\"\",\n \"slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast,\",\n \"binary form must reproduce the above copyright # notice, this list of conditions\",\n \"(c) 1999-2008 <NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company\",\n \"form must reproduce the above copyright # notice, this list of conditions and\",\n \"and the following disclaimer; # redistributions in binary form must reproduce the above\",\n \"<NAME> and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company # All\",\n \"STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\",\n \"slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts\",\n \"derived from # this software without specific prior written permission. # # THIS\",\n \"WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN\",\n \"IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR\",\n \"= self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs,\",\n \"in self: return set() if parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else:\",\n \"# contributors may be used to endorse or promote products derived from #\",\n \"the above copyright # notice, this list of conditions and the following disclaimer\",\n \"PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS\",\n \"% ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the\",\n \"EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\",\n \"import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs)\",\n \"Copyright (c) 2009 The Hewlett-Packard Development Company # All rights reserved. # #\",\n \"generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new type new_type\",\n \"following disclaimer; # redistributions in binary form must reproduce the above copyright #\",\n \"and the following disclaimer in the # documentation and/or other materials provided with\",\n \"self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields\",\n \"forms, with or without # modification, are permitted provided that the following conditions\",\n \"of the fields of the type to it for field in self.field_asts: field.generate(new_type)\",\n \"are # met: redistributions of source code must retain the above copyright #\",\n \"source code must retain the above copyright # notice, this list of conditions\",\n \"FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\",\n \"CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\",\n \"in source and binary forms, with or without # modification, are permitted provided\",\n \"type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame()\",\n \"provided with the distribution; # neither the name of the copyright holders nor\",\n \"IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF\",\n \"return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None): if \\\"external\\\" in self: return\",\n \"class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast =\",\n \"# # Redistribution and use in source and binary forms, with or without\",\n \"AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR\",\n \"SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def\",\n \"= field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None): if\",\n \"OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\",\n \"used to endorse or promote products derived from # this software without specific\",\n \"IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\",\n \"BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR\",\n \"promote products derived from # this software without specific prior written permission. #\",\n \"COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, #\",\n \"prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS\",\n \"ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\",\n \"return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def generate(self): ident = str(self.type_ast) machine\",\n \"the distribution; # neither the name of the copyright holders nor the names\",\n \"# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\",\n \"(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE #\",\n \"HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\",\n \"OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from\",\n \"AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE\",\n \"if parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return\",\n \"following disclaimer in the # documentation and/or other materials provided with the distribution;\",\n \"self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def generate(self): ident = str(self.type_ast)\",\n \"the fields of the type to it for field in self.field_asts: field.generate(new_type) self.symtab.popFrame()\",\n \"IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO,\",\n \"use in source and binary forms, with or without # modification, are permitted\",\n \"in binary form must reproduce the above copyright # notice, this list of\",\n \"OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF\",\n \"# All rights reserved. # # Redistribution and use in source and binary\",\n \"above copyright # notice, this list of conditions and the following disclaimer; #\",\n \"CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\",\n \"machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type to\",\n \"to endorse or promote products derived from # this software without specific prior\",\n \"# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS\",\n \"ident, \\\"%s.cc\\\" % ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine #\",\n \"if \\\"external\\\" in self: return set() if parent: ident = \\\"%s_%s\\\" % (parent,\",\n \"of conditions and the following disclaimer; # redistributions in binary form must reproduce\",\n \"name of the copyright holders nor the names of its # contributors may\",\n \"# neither the name of the copyright holders nor the names of its\",\n \"# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL,\",\n \"\\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED\",\n \"copyright holders nor the names of its # contributors may be used to\",\n \"DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts):\",\n \"the following disclaimer; # redistributions in binary form must reproduce the above copyright\",\n \"ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new\",\n \"new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type)\",\n \"HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\",\n \"holders nor the names of its # contributors may be used to endorse\",\n \"products derived from # this software without specific prior written permission. # #\",\n \"USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\",\n \"# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING\",\n \"documentation and/or other materials provided with the distribution; # neither the name of\",\n \"# redistributions in binary form must reproduce the above copyright # notice, this\",\n \"from # this software without specific prior written permission. # # THIS SOFTWARE\",\n \"slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc,\",\n \"Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all\",\n \"type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def\",\n \"parent: ident = \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\"\",\n \"# Copyright (c) 2009 The Hewlett-Packard Development Company # All rights reserved. #\",\n \"LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\",\n \"be used to endorse or promote products derived from # this software without\",\n \"conditions are # met: redistributions of source code must retain the above copyright\",\n \"OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\",\n \"%r]\\\" % (self.type_ast) def files(self, parent=None): if \\\"external\\\" in self: return set() if\",\n \"USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH\",\n \"reproduce the above copyright # notice, this list of conditions and the following\",\n \"OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST):\",\n \"BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\",\n \"OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\",\n \"and binary forms, with or without # modification, are permitted provided that the\",\n \"names of its # contributors may be used to endorse or promote products\",\n \"AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL\",\n \"# Add all of the fields of the type to it for field\",\n \"the following conditions are # met: redistributions of source code must retain the\",\n \"POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class\",\n \"conditions and the following disclaimer; # redistributions in binary form must reproduce the\",\n \"neither the name of the copyright holders nor the names of its #\",\n \"IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # \\\"AS IS\\\" AND ANY\",\n \"(self.type_ast) def files(self, parent=None): if \\\"external\\\" in self: return set() if parent: ident\",\n \"modification, are permitted provided that the following conditions are # met: redistributions of\",\n \"TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE\",\n \"of conditions and the following disclaimer in the # documentation and/or other materials\",\n \"WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND\",\n \"# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT #\",\n \"# met: redistributions of source code must retain the above copyright # notice,\",\n \"ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED\",\n \"ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN\",\n \"EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST\",\n \"OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR\",\n \"FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\",\n \"INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT,\",\n \"\\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None): if \\\"external\\\" in self: return set()\",\n \"CONTRIBUTORS # \\\"AS IS\\\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\",\n \"OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF\",\n \"LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR\",\n \"OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF\",\n \"THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE\",\n \"# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT\",\n \"self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None):\",\n \"the following disclaimer in the # documentation and/or other materials provided with the\",\n \"must reproduce the above copyright # notice, this list of conditions and the\",\n \"EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE\",\n \"TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast\",\n \"DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE\",\n \"else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def generate(self):\",\n \"The Hewlett-Packard Development Company # All rights reserved. # # Redistribution and use\",\n \"PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS\",\n \"CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\",\n \"ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE\",\n \"DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import Type class TypeDeclAST(DeclAST): def __init__(self,\",\n \"in the # documentation and/or other materials provided with the distribution; # neither\",\n \"set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def generate(self): ident = str(self.type_ast) machine =\",\n \"# Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if\",\n \"permitted provided that the following conditions are # met: redistributions of source code\",\n \"the name of the copyright holders nor the names of its # contributors\",\n \"\\\"%s.cc\\\" % ident)) def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make\",\n \"materials provided with the distribution; # neither the name of the copyright holders\",\n \"MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\",\n \"parent=None): if \\\"external\\\" in self: return set() if parent: ident = \\\"%s_%s\\\" %\",\n \"= Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add\",\n \"2009 The Hewlett-Packard Development Company # All rights reserved. # # Redistribution and\",\n \"list of conditions and the following disclaimer in the # documentation and/or other\",\n \"(parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident))\",\n \"the names of its # contributors may be used to endorse or promote\",\n \"retain the above copyright # notice, this list of conditions and the following\",\n \"super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl:\",\n \"the # documentation and/or other materials provided with the distribution; # neither the\",\n \"reserved. # # Redistribution and use in source and binary forms, with or\",\n \"# Redistribution and use in source and binary forms, with or without #\",\n \"self.symtab.pushFrame() # Add all of the fields of the type to it for\",\n \"def generate(self): ident = str(self.type_ast) machine = self.symtab.state_machine # Make the new type\",\n \"nor the names of its # contributors may be used to endorse or\",\n \"DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\",\n \"SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF\",\n \"__init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts =\",\n \"self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the\",\n \"PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS;\",\n \"Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine) if machine:\",\n \"OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\",\n \"LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\",\n \"self.symtab.state_machine # Make the new type new_type = Type(self.symtab, ident, self.location, self.pairs, self.state_machine)\",\n \"TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE\",\n \"files(self, parent=None): if \\\"external\\\" in self: return set() if parent: ident = \\\"%s_%s\\\"\",\n \"binary forms, with or without # modification, are permitted provided that the following\",\n \"of source code must retain the above copyright # notice, this list of\",\n \"following conditions are # met: redistributions of source code must retain the above\",\n \"OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY,\",\n \"def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast) def files(self, parent=None): if \\\"external\\\" in\",\n \"may be used to endorse or promote products derived from # this software\",\n \"Company # All rights reserved. # # Redistribution and use in source and\",\n \"met: redistributions of source code must retain the above copyright # notice, this\",\n \"and <NAME> # Copyright (c) 2009 The Hewlett-Packard Development Company # All rights\",\n \"# modification, are permitted provided that the following conditions are # met: redistributions\",\n \"# # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS #\",\n \"OF THE POSSIBILITY OF SUCH DAMAGE. from slicc.ast.DeclAST import DeclAST from slicc.symbols.Type import\",\n \"copyright # notice, this list of conditions and the following disclaimer; # redistributions\",\n \"THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\",\n \"INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED\",\n \"Type class TypeDeclAST(DeclAST): def __init__(self, slicc, type_ast, pairs, field_asts): super(TypeDeclAST, self).__init__(slicc, pairs) self.type_ast\",\n \"= \\\"%s_%s\\\" % (parent, self.type_ast.ident) else: ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident,\",\n \"GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\",\n \"LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT\",\n \"OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY\",\n \"INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\",\n \"self).__init__(slicc, pairs) self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\"\",\n \"self.type_ast = type_ast self.field_asts = field_asts def __repr__(self): return \\\"[TypeDecl: %r]\\\" % (self.type_ast)\",\n \"# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\",\n \"ident, self.location, self.pairs, self.state_machine) if machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of\",\n \"of the copyright holders nor the names of its # contributors may be\",\n \"written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\",\n \"copyright # notice, this list of conditions and the following disclaimer in the\",\n \"or promote products derived from # this software without specific prior written permission.\",\n \"INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO,\",\n \"specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT\",\n \"ident = self.type_ast.ident return set((\\\"%s.hh\\\" % ident, \\\"%s.cc\\\" % ident)) def generate(self): ident\"\n]","isConversational":false}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":2,"numItemsPerPage":100,"numTotalItems":12866649,"offset":200,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc3NDM1MTIxMywic3ViIjoiL2RhdGFzZXRzL3RlcnJ5eXovc3RhcmNvZGVyZGF0YV9uZ3JhbV8xMyIsImV4cCI6MTc3NDM1NDgxMywiaXNzIjoiaHR0cHM6Ly9odWdnaW5nZmFjZS5jbyJ9.VHmXgrMMhLW7f8F6aZNlHK_byI0BfvMmeWF6U15nTd-k9CtkRTNeAlSciwJCsI2d29VNuWKL8_GEG3Geld08AA","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":12866649,"numBytesParquet":149232926747}]},"discussionsStats":{"closed":0,"open":0,"total":0},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
ngram listlengths 0 67.8k |
|---|
[
"__init__(self, d_model, heads, d_ff, dropout): super(TransformerDecoderLayer, self).__init__() self.self_attn = MultiHeadedAttention( heads, d_model, dropout=dropout)",
"emb): return self.pe[:, :emb.size(1)] class TransformerEncoderLayer(nn.Module): def __init__(self, d_model, heads, d_ff, dropout): super(Transf... |
[
"= \"https\" def complete_login(self, request, app, token, **kwargs): response = requests.post( self.profile_url, headers={\"Authorization\":",
"= \"https://api.dropbox.com/2/users/get_current_account\" redirect_uri_protocol = \"https\" def complete_login(self, request, app, token, **kwargs): response =",
"toke... |
[
"= '1.2.7' # The full version, including alpha/beta/rc tags release = f'v{version}' #",
"tags release = f'v{version}' # endregion # region General configuration # Add any",
"sys.path.insert(0, os.path.abspath('..')) # endregion # region Project information project = 'Upkeep' copyright =",
"contain templates h... |
[
"variables def get_enums(header): enums = [e for e in header.enums if e.get(\"name\")] #",
"return enums def read_header(header_path, skip_macros=None): # I tried to do this in multiple",
"main_classes[(module, header)] methods_defined_outside = get_methods_defined_outside(header_functions) class_definitions = ... |
[
"= codecs.open(os.environ[\"script\"], encoding='utf-8', mode='r') command = f.read() command = command.replace(\"$uid\", uid) # Call",
"and replace params winrm_wrapper.writeLog(\"loading script\") f = codecs.open(os.environ[\"script\"], encoding='utf-8', mode='r') command = f.read()",
"stored in environment a... |
[
"@registry.extensible_enum class ExtensibleEnumeration(Enum): a = auto() b = auto() class RegistryTests(unittest.TestCase): def test_class_registry(self):",
"@registry.autoregister class Extension4(object): pass def test_enum_registry(self): ExtensibleEnumeration.register('c') self.assertTrue(ExtensibleEnumeratio... |
[
"handler.wait_closed() await finalize() @pytest.fixture async def setup_logger(make_tcp_handler): async def go(*args, **kwargs): handler, server",
"[loads(i) for i in s.split(\"\\n\") if i] async def close(self): if self.server is",
"yield go async def finalize(): for server in servers: await server.close() awa... |
[
"(not isinstance(value, dict) or not self._is_tc_entity(value)): raise RuntimeError('Invalid data provided for TcEntity.') #",
"proper structure for Key Value.\"\"\" if data is None: return False return all(x",
"self._output_variables_by_name = {} self._output_variables_by_type = {} for ov in self._output_varia... |
[
"dtype=tf.int32), }) if is_training: if hvd is not None: d = d.shard(hvd.size(), hvd.rank())",
"\"Whether to enable AMP ops. When false, uses TF32 on A100 and FP32",
"Unless required by applicable law or agreed to in writing, software # distributed",
"is_training, drop_remainder, hvd=None): \"\"\"Creates an `... |
[
"| Student.objects.filter(programme = \"PhD\") assistant_list = AssistantshipClaim.objects.filter(ta_supervisor_remark = True).filter(thesis_supervisor_remark = True).filter(hod_approval =True).filter(acad_approval =",
"no in excel file roll_no - details of student from file first_name -",
"def get_context(requ... |
[
"License is distributed on an \"AS IS\" BASIS, WITHOUT # WARRANTIES OR CONDITIONS",
"writing, software # distributed under the License is distributed on an \"AS IS\"",
"Unless required by applicable law or agreed to in writing, software # distributed",
"subject.cmd.replicator ' 'compare az1:9292 az2:9292 --de... |
[
"date(1970, 5, 30), date(1971, 5, 31), date(1997, 5, 26), date(1999, 5, 31), date(2000,",
"4, 15), self.markettradingdayss.BtwDates(current_date, future_date)) self.assertNotIn(date(2021, 4, 18), self.markettradingdayss.BtwDates(current_date, future_date)) # if __name__ ==",
"nc_marketholidayss) nc_marketholida... |
[
"#!/usr/bin/env python from distutils.core import setup from catkin_pkg.python_setup import generate_distutils_setup d = generate_distutils_setup(",
"import setup from catkin_pkg.python_setup import generate_distutils_setup d = generate_distutils_setup( packages=['rosmsg'], package_dir={'': 'src'}, scripts=['scri... |
[
"= None def insert(self, value): self.list = Node(value, self.list) def start_iter(self): return self.list",
"\"\"\" Main execution function \"\"\" if test: return ############################################################################### # Executable code ####################################################... |
[
"of the spatial stencil discretisation. Defaults to 4. kernel : selects a visco-acoustic",
"return rec, p, v, summary def adjoint(self, rec, srca=None, va=None, pa=None, vp=None, qp=None,",
"or array-like The receiver data. Please note that these act as the source",
"= r or TimeFunction(name=\"r\", grid=self.... |
[
"') itemSetList.append(list(map(int, cates))) def myApriori(): te = TransactionEncoder() te_ary = te.fit(itemSetList).transform(itemSetList) df =",
"TransactionEncoder() te_ary = te.fit(itemSetList).transform(itemSetList) df = pd.DataFrame(te_ary, columns=te.columns_) return df def dataInit(): if",
"= line.repl... |
[
"= request_json['name'] headers = { 'Access-Control-Allow-Origin': 'https://furikuri.net', 'Access-Control-Allow-Methods': 'GET, POST', 'Access-Control-Allow-Headers': 'Content-Type' }",
"<reponame>FuriKuri/faas-playground def hello_world(request): request_json = request.get_json() name = 'World' if request_json ... |
[
"from tonclient.client import TonClient from tonclient.types import Abi, CallSet, Signer, ClientConfig, \\ ParamsOfEncodeMessage,",
"signer=Signer.NoSigner(), address=GIVER_ADDRESS, call_set=call_set) process_params = ParamsOfProcessMessage( message_encode_params=encode_params, send_events=False) async_core_clien... |
[
"'/test_i18n': return s.upper() return s i18n.gettext = gettext def test_does_translations(app): \"\"\"Callback interface is",
"we test for request path that only functions from this module could set",
"# so we test for request path that only functions from this module",
"== '/test_i18n': return s.upper() ret... |
[
"else: w_scale, h_scale = scale_factor[0], scale_factor[1] img_h = np.round(ori_shape[0] * h_scale.item()).astype( np.int32) img_w",
"- y0) * 2 - 1 img_x = (img_x - x0) / (x1",
"shape (n, 4/5) det_labels (Tensor): shape (n, ) img_shape (Tensor): shape (3, )",
"mask_targets @force_fp32(apply_to=('mask_pred', )... |
[
"= Config() #params for text detector cfg.det_algorithm = \"DB\" cfg.det_model_dir = \"./inference/ch_ppocr_mobile_v2.0_det_infer/\" cfg.det_limit_side_len",
"1.6 cfg.use_dilation = False # #EAST parmas # cfg.det_east_score_thresh = 0.8 # cfg.det_east_cover_thresh",
"cfg.det_db_unclip_ratio = 1.6 cfg.use_dilati... |
[
") self.res = DoubleResNet(BasicBlock,deconv_outplanes+skip_inplanes,res_outplanes,stride=1) def forward(self,x,skip_x): out = self.deconv(x,output_size=skip_x.size()) # concat skip connections",
"self.inplanes, kernel_size=7, stride=1, padding=3, bias=True) # initial conv layer self.bn1 = nn.BatchNorm2d(self.inp... |
[
"in range(len(examples))] questions = [examples[i]['question'] for i in range(len(examples))] tokenized_examples = tokenizer( questions,",
"import paddle from paddle.io import DataLoader from args import parse_args import paddlenlp as",
"Stack(dtype=\"int64\") }): fn(samples) train_data_loader = DataLoader( dat... |
[
"# env.render() # # # Update Q table with new knowledge # Q[s,",
"--> Identity s: s + 1: [[1. 0. 0. 0. 0. 0. 0.",
"Q = np.zeros([env.observation_space.n, env.action_space.n]) # # # List of reward and steps per",
"greedy # print(\"s = \", s,\" --> Identity s:s+1: \", np.identity(env.observation_space.n)[s:s+1]... |
[
"'RsaSsaPkcs1PrivateKey': [ 'RSA_SSA_PKCS1_3072_SHA256_F4', 'RSA_SSA_PKCS1_4096_SHA512_F4' ], 'RsaSsaPssPrivateKey': [ 'RSA_SSA_PSS_3072_SHA256_SHA256_32_F4', 'RSA_SSA_PSS_4096_SHA512_SHA512_64_F4' ], 'AesCmacPrfKey': ['AES_CMAC_PRF'], 'HmacPrfKey':",
"'ECDSA_P256_IEEE_P1363': signature.signature_key_templates.EC... |
[
"key hash {}'.format(key['public_key'], key_hash)) else: logging.warning(\"Couldn't public key for key hash {}\".format(key_hash)) response",
"level=logging.INFO) app = Flask(__name__) # sample config used for testing config = {",
"= None try: if key_hash in config['keys']: key = config['keys'][key_hash] respon... |
[
"0x1 UNW_FLAG_UHANDLER = 0x2 UNW_FLAG_FHANDLER = 0x3 UNW_FLAG_CHAININFO = 0x4 def read_unwind_info(view, address):",
"None: runtime_function['BeginAddress'] += view.start runtime_function['EndAddress'] += view.start runtime_function['UnwindData'] += view.start return runtime_function, address",
"is None: contin... |
[
"fig.add_trace(traces[0]) idx = len(fig.data) - 1 for i, tr in enumerate(traces): frames.append(go.Frame(name=str(i), traces=[idx],",
"z = corners.T tr = go.Scatter3d( x=x, y=y, z=z, line=dict(color='rgba(0, 0, 0, .5)'),",
"def plot_camera(fig, R, t, K, color='rgb(0, 0, 255)'): \"\"\"Plot a camera as a",
"z=[... |
[
"= True def check_victory(check_grids: np.ndarray) -> set[int]: \"\"\"return empty set if no victory,",
"set if no victory, else set of id of the wining grids\"\"\" return",
"<filename>day04/c.py import numpy as np GRID_SIZE = 5 def read_bingo_grid(lines: list[str]) -> list[list[int]]:",
"np.ndarray, number: ... |
[
"alt.selection_single(name='year', fields=['year'], bind=slider) base = alt.Chart(pop).add_selection( select_year ).transform_filter( select_year ).transform_calculate( gender=if_(datum.sex == 1,",
"# category: case studies import altair as alt from altair.expr import datum, if_",
"select_year ).transform_calcu... |
[
"[ migrations.CreateModel( name='Token', fields=[ ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')), ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')), ('name',"... |
[
"= db.Column(db.DateTime) # # def __init__(self, uuid, payload, datetime): # self.uuid = uuid",
"self.uuid = uuid # self.payload = payload # self.datetime = datetime # #",
"payload # self.datetime = datetime # # def __repr__(self): # return '<Data %r>'",
"= db.Column(db.Integer, primary_key=True) uuid = db.Co... |
[
"= iface self.pre_iface_state = _iface_state(iface) self.iface_state = self.pre_iface_state self.post_iface_state = '' def iface_up(self):",
"state returns UP, DOWN, UNKNOWN \"\"\" state = command_util('ip', 'link', 'show', iface).stdout.read() search_result",
"range_start[i] < 255: yield '.'.join([str(item) fo... |
[
"schemas.category import CategorySchema from schemas.facts_in_data import FactsInDataSchema from schemas.market import MarketSchema from schemas.period",
"from schemas.brand import BrandSchema from schemas.category import CategorySchema from schemas.facts_in_data import FactsInDataSchema from",
"import FactsInD... |
[
"and compare the results of with your # improved architecture. # # Be",
"pass to fully-connected layer batch = batch.view(-1, self.num_flat_features(batch)) # Connect the reshaped features",
"an activition function to 'batch' #batch = func.sigmoid(batch) return batch def num_flat_features(self, inputs):",
"Pa... |
[
"= timedelta(weeks = 1) last_week = today - delta begin_date = last_week.strftime('%Y%m%d') url",
"= json.loads(json_url.read()) except: raise RuntimeError('Failed to retrive New York Times data.') if articles['status']",
"= today - delta begin_date = last_week.strftime('%Y%m%d') url = 'https://api.nytimes.com/... |
[
"str(i), status=api_types.TrialComponentStatus(primary_status=\"InProgress\", message=\"E\" + str(i)), start_time=start_time + datetime.timedelta(hours=i), end_time=end_time + datetime.timedelta(hours=i), creation_time=creation_time +",
"} for i in range(10) ], \"NextToken\": \"100\", }, { \"TrialComponentSummari... |
[
"# 1. update preserved oligo length olg5p.incrementLength(new_olg3p.length()) # 2. Remove the old oligo",
"oligo length olg5p.incrementLength(old_olg3p.length()) # 2. Remove the old oligo and apply the 5'",
"2. install the crossover 3. update the oligo length 4. apply the new",
"def def undo(self): part = sel... |
[
"temperature_in_celsius = sensor.get_temperature() temperature_in_fahrenheit = sensor.get_temperature(W1ThermSensor.DEGREES_F) temperature_in_all_units = sensor.get_temperatures([W1ThermSensor.DEGREES_C, W1ThermSensor.DEGREES_F, W1ThermSensor.KELVIN]) print(\"Sensor id:\"",
"temperature_in_fahrenheit = sensor.get... |
[
"Generated by Django 3.1.1 on 2020-09-01 17:04 from django.db import migrations, models class",
"('tables', '0003_exposure_category'), ] operations = [ migrations.AlterField( model_name='exposure', name='location', field=models.CharField(blank=True, default='', max_length=200), ),",
"2020-09-01 17:04 from djang... |
[
"#Copyright ReportLab Europe Ltd. 2000-2016 #see license.txt for license details #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/__init__.py __version__='3.3.0'",
"Europe Ltd. 2000-2016 #see license.txt for license details #history http://www.reportlab.co.u... |
[
"requirements, but is specifically disallowed for this image. Please try a different value.\".format(username))",
"_validate_vm_create_nsg(cmd, namespace): if namespace.nsg: if check_existence(cmd.cli_ctx, namespace.nsg, namespace.resource_group_name, 'Microsoft.Network', 'networkSecurityGroups'): namespace.nsg_t... |
[
"# print(0 + i - 3) return answer[0 : 0 + i -",
"+ len(questions[i]) end = bodyText.index(questions[i + 1], start, -1) print(\"Start : \", start",
"print(bodyText) questionCount = len(questions) answerList = [] for i in range(0, questionCount): print('Q:",
"\"https://transportation.oregonstate.edu/aabc/freque... |
[
"\"bright_cyan\", \"bright_white\", ), range(90, 98)))) BG_COLORS = dict((f\"on_{key}\", val + 10) for key,",
"invisibles (for readline); else False. Returns: A string with the original text wrapped",
"def readline_disabled(): \"\"\"Context manager to temporarily disable readline features. \"\"\" readline.set_a... |
[
"kernel_size=3, stride=1, padding=1) ) TEST_CASE_SUBPIXEL_CONV_BLOCK_EXTRA = [ {\"dimensions\": 3, \"in_channels\": 1, \"scale_factor\": 2,",
"writing, software # distributed under the License is distributed on an \"AS IS\"",
"1, 16, 8, 4), # different size for H, W and D (2,",
"nn from parameterized import p... |
[
"CFGBuilder userCfg = CFGBuilder().build_from_file('user.py', './auction/user.py') bidCfg = CFGBuilder().build_from_file('bid.py', './auction/bid.py') auctionCfg = CFGBuilder().build_from_file('auction.py','./auction/auction.py') #auctionEventCfg",
"userCfg = CFGBuilder().build_from_file('user.py', './auction/use... |
[
"= float(input()) while True: command = input() if command == \"End\": break money",
"minimal_budget = float(input()) while True: command = input() if command == \"End\": break",
"money = float(command) total_budget += money if total_budget >= minimal_budget: print(f\"Going to {destination}!\")",
"= float(com... |
[
"from footmark.regioninfo import RegionInfo class RAMRegionInfo(RegionInfo): \"\"\" Represents an ram Region \"\"\" def",
"def __init__(self, connection=None, name=None, id=None, connection_cls=None): from footmark.ram.connection import RAMConnection super(RAMRegionInfo, self).__init__(connection, name,",
"impo... |
[
"a single histogram to a D3PO plot :param plot: Glue histogram :type plot:",
"plot :class:`~glue.viewers.scatter.qt.ScatterViewer` :param index: 1D index of plot on the page :type index:",
"- The Glue session must have only one dataset open, and 0 or",
"save_page(page, page_number, label, subset): \"\"\" Conv... |
[
"P.A. é (', end='') while c <= 10: print('{}'.format(termo), end='') print(', ' if",
"(', end='') while c <= 10: print('{}'.format(termo), end='') print(', ' if c <",
"print(', ' if c < 10 else '', end='') termo += r c",
"termo da P.A.: ')) r = int(input('Digite a razão: ')) termo = n1",
"n1 c = 1 print('A ... |
[
"a connection without committing the changes first will cause an implicit rollback to",
".extensions import PARSE_DECLTYPES, PARSE_COLNAMES class Connection(object): from .exceptions import ( Warning, Error, InterfaceError,",
"self._connection.request(method, uri, body=body, headers=dict(self._headers, **header... |
[
"rent = total_price * 0.1 total_price = total_price - rent if total_price >=",
"rent if total_price >= price: print(f\"Yes! {(total_price - price):.2f} lv left.\") else: print(f\"Not",
"minions = int(input()) trucks = int(input()) total_toys = puzzles + dolls + bears",
"= int(input()) trucks = int(input()) to... |
[
"License is distributed on an \"AS IS\" BASIS, WITHOUT # WARRANTIES OR CONDITIONS",
"writing, software # distributed under the License is distributed on an \"AS IS\"",
"return json.dumps((self._cache.get(key), dt.strftime('%s'))) def set(self, key, value, timeout=None): self.set_value = value self.set_key =",
... |
[
"EqualTo class NullableDateTimeField(DateTimeField): \"\"\"Modify DateField to allow for Null values\"\"\" def process_formdata(self, valuelist):",
"import DataRequired, ValidationError, Email, EqualTo class NullableDateTimeField(DateTimeField): \"\"\"Modify DateField to allow for Null",
"ValidationError, Email... |
[
"header=None, engine='python') train_labels = train_labels.to_numpy() # convertim data frame-ul intr-un vector train_labels =",
"_ = normalize_data(validation_features, validation_features) # Aplicam modelul SVM model_svm = svm.SVC(kernel='linear', C=23, gamma=110)",
"return scaled_train_data, scaled_test_data ... |
[] |
[
"from flytekit.core.promise import ( NodeOutput, Promise, VoidPromise, binding_from_python_std, create_and_link_node, create_native_named_tuple, create_task_output, translate_inputs_to_literals, )",
"a Python native value. for k, v in kwargs.items(): if not isinstance(v, Promise):",
"need to run through the fun... |
[
"+ betas[T - 1, U - 1]) # The above is also equivalent",
"Unless required by applicable law or agreed to in writing, software # distributed",
"if T != max_T: raise ValueError(f\"Input length mismatch! Given T: {T}, Expected max",
"- 1] # // grad to last blank transition grads[T - 1, U",
"Unused. Tensor of s... |
[
"as np import math from dataset_specifications.dataset import Dataset class SwirlsSet(Dataset): def __init__(self): super().__init__()",
"= means + std*noise return ys def sample(self, n): xs = np.random.uniform(low=0., high=2.,",
"math from dataset_specifications.dataset import Dataset class SwirlsSet(Dataset)... |
[
"initialization() # run cpp tests get_json_report(test_list, options) # collect coverage data from json",
"run cpp tests get_json_report(test_list, options) # collect coverage data from json profiles if",
"= time.time() (options, test_list, interested_folders) = initialization() # run cpp tests get_json_report(... |
[
"a given Tweet. Example: predict_user('ausen', 'elonmusk', 'Lambda School Rocks!') Returns 1 corresponding to",
"'elonmusk', 'Lambda School Rocks!') Returns 1 corresponding to 1st user passed in, or",
"to 1st user passed in, or 0 for second. \"\"\" user1 = User.query.filter(User.name",
"np from sklearn.linear... |
[
"States. # Additionally, the Government of the District of Columbia waives # copyright",
"worldwide through the CC0 1.0 # Universal public domain dedication. __version__ = '1.0.0'",
"python # -*- coding: utf-8 -*- # This file is part of groupthink.",
"-*- coding: utf-8 -*- # This file is part of groupthink. #... |
[
"[l in rank[i, -top_k:] for i, l in enumerate(self.label)] return sum(hit_top_k) * 1.0",
"= score.argsort() hit_top_k = [l in rank[i, -top_k:] for i, l in enumerate(self.label)]",
"self.sample_name = os.listdir(self.data_path) if self.debug: self.sample_name = self.sample_name[0:2] # load label label_path =",
... |
[
"'Sexual Content'), ('OTHER', 'Other')], max_length=50)), ('description', models.TextField()), ('date', models.DateTimeField(auto_now_add=True)), ('to_vit', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='vit.vit')), ('user',",
"options={ 'ordering': ['name'], }, ), migrations.CreateModel( name... |
[
"schema_type): with grpc.insecure_channel(f\"localhost:{self.input_port}\") as channel: stub = pb2_grpc.SchemaRegistryStub(channel) resp = stub.AddSchema( pb2.NewSchema( definition=bytes(body,",
"if self.initial_schema is not None: env.update(SCHEMA_REGISTRY_IMPORT_FILE=self.initial_schema) self.svc = subprocess.... |
[
"a routing policy is set with an empty condition, it should be loaded",
"EchoedRequest pytestmark = [ pytest.mark.skipif(\"TESTED_VERSION < Version('2.11')\"), pytest.mark.issue(\"https://issues.redhat.com/browse/THREESCALE-6415\")] @pytest.fixture(scope=\"module\") def service_proxy_settings(private_base_url): \... |
[
"# # Licensed under the Apache License, Version 2.0 (the \"License\"); # you",
"writing, software # distributed under the License is distributed on an \"AS IS\"",
"[ '%s.create' % self.resource_name, '%s.update' % self.resource_name, '%s.delete' % self.resource_name, ] @staticmethod def",
"or # implied. # See... |
[
"Select from Data.parameters import Data from get_dir import pwd from reuse_func import GetData",
"def __init__(self,driver): self.driver = driver self.filename ='' def test_download_csv(self): self.data = GetData() self.p",
"import Data from get_dir import pwd from reuse_func import GetData class All_records_d... |
[
"= compat_cookiejar_Cookie( version=0, name=name, value=value, port=None, port_specified=False, domain=host, domain_specified=bool(host), domain_initial_dot=host.startswith('.'), path=path, path_specified=bool(path), secure=is_secure,",
"--enable-logging=stderr --v=1 2>&1 | grep key_storage_ # Chromium supports a... |
[
"managers def _ensure_present(mgr): try: mgr.version() except Exception: pytest.skip() @pytest.fixture def tmpdir_as_cwd(tmpdir): with tmpdir.as_cwd():",
"managers.GitManager() _ensure_present(mgr) mgr._invoke('init') mgr._invoke('config', 'user.email', '<EMAIL>') mgr._invoke('config', 'user.name', 'HGTools') os.... |
[
"isinstance(other, SQLQuery): self.items.extend(other.items) else: return NotImplemented return self def __len__(self): return len(self.query()) def",
"def query(self, paramstyle=None): \"\"\" Returns the query part of the sql query. >>>",
"and `offset`. Uses vars to interpolate. Otherwise, each clause can be a... |
[
"'<KEY> # SECURITY WARNING: don't run with debug turned on in production! DEBUG",
"= [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dddp', 'dddp.server', 'dddp.accounts', 'dddppp.slides', ]",
"'... |
[
"python from setuptools import setup import os __doc__ = \"\"\" Command line tool",
"#!/usr/bin/env python from setuptools import setup import os __doc__ = \"\"\" Command line",
":: BSD License\", \"Topic :: System :: Networking\", \"Operating System :: POSIX ::",
"return open(os.path.join(os.path.dirname(__f... |
[
"auth_api.utils.util import cors_preflight API = Namespace('products', description='Endpoints for products management') TRACER = Tracer.get_instance()",
"endpoints for managing an Org resource.\"\"\" from flask import request from flask_restplus import",
"Namespace('products', description='Endpoints for product... |
[
").count(), Application.QUESTION: all_apps.filter( status=Application.QUESTION, partner__coordinator__editor=coordinator[0], ).count(), Application.APPROVED: all_apps.filter( status=Application.APPROVED, partner__coordinator__editor=coordinator[0], ).count(), } editor",
"import Application from TWLight.resources.... |
[
"wavelength=555, polarisation=None): super(Laser, self).__init__() self.position = np.array(position) self.direction = np.array(direction) self.wavelength = wavelength",
"photon.active = True return photon class RadialSource(object): \"\"\" A point source that emits",
"Laser is not set.\" self.polarisation = np... |
[
"0), (1, 1)]: ... bit.circuit(circuit()) ... b = output(input(x) @ input(y)) ... results.append(int(b)",
"other)]) def nand_(self: bits, other) -> bits: \"\"\" >>> results = [] >>>",
"== c.evaluate([x, x, x, y, y, y])) >>> all(results) True \"\"\" return bits([x.imp_(y)",
"of logic circuits and synthesizing c... |
[
"author = df['author'].to_list() message_counter = {} for i in author: if i in",
"# for not mentioning the bot in the line graph. message_counter.pop('ninza_bot_test') authors_in_discord =",
"graph. message_counter.pop('ninza_bot_test') authors_in_discord = list(message_counter.keys()) no_of_messages = list(mes... |
[
"#!/usr/bin/env python3 import os from setuptools import setup def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read()",
"\"tqdm\"], python_requires=\">=3.6\", entry_points={\"console_scripts\": [\"fastnode2vec = fastnode2vec.cli:node2vec\"]}, classifiers=[\"Topic :: Scientific/Enginee... |
[
"os basedir = os.path.abspath(os.path.dirname(__file__)) class Config: SECRET_KEY = os.getenv('SECRET_KEY', '') DEBUG = False",
"True SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'flask_main.db') PRESERVE_CONTEXT_ON_EXCEPTION = False SQLALCHEMY_TRACK_MODIFICATIONS = False",
"= False class Prod... |
[
"exists' % self.user except KeyError: success = False ret_msg = 'User %s does",
"True ret_msg = 'User %s exists' % self.user except KeyError: success = False",
"chkusr.check_if_user_exists() # Error handling and JSON return if success: module.exit_json(msg=ret_msg) else: module.fail_json(msg=ret_msg) if",
"= ... |
[
"an appropriate ontology term. Args: label: the label to find ontology terms for",
"a given curie like 'CL:1000413', get the label like 'endothelial cell of artery'\"\"\"",
"and you want to find an appropriate ontology term. Args: label: the label",
"f\"http://purl.obolibrary.org/obo/{_ontology_name(curie)}_{... |
[
"\"operator\": \"\", \"operand\": \"\", \"field\": \"\", \"selector\": \"\" ], \"likely_metric\": \"\" } \"\"\"",
"TORT (INCLUDING NEGLIGENCE OR # OTHERWISE) ARISING IN ANY WAY OUT OF THE",
"'cut': EditableFilterSerializer().to_representation(cut), 'cohorts': cohort_serializer(many=True).to_representation(cohor... |
[
"or credentials.invalid: flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES) flow.user_agent = APPLICATION_NAME if flags: credentials =",
"'client_secret.json' APPLICATION_NAME = 'Inbox Organize' def get_credentials(): \"\"\"Gets valid user credentials from storage.",
"with Python 2.6 credentials ... |
[
"halogalaxystruct1') return halogalaxystruct1 else: print('found HALO_FORMAT_REVISION=%d, if this is >1 email me!' %",
"('num_child_particles',np.int64), ('p_start',np.int64), ('desc',np.int64), ('flags',np.int64), ('n_core',np.int64), ('dummy2',np.float32), ## ALIGNMENT ('min_pos_err',np.float32), ('min_vel_err'... |
[
"def location(self): \"\"\" Retrieve the location of an event :return: location :rtype: str",
"describing the event :rtype: str \"\"\" return (\"| \" + self.begin_date + self.end_date",
"= self.event.location if location.lower() in locations.keys(): location = locations[location.lower()] return location @proper... |
[
"os import random import re import sys # Complete the rotLeft function below.",
"rotLeft(a, d): alist = list(a) b = alist[d:]+alist[:d] return b if __name__ ==",
"= list(a) b = alist[d:]+alist[:d] return b if __name__ == '__main__': fptr =",
"= int(nd[0]) d = int(nd[1]) a = list(map(int, input().rstrip().spli... |
[
"import cflearn import platform import unittest from cfdata.tabular import TabularDataset num_jobs = 0",
"TabularDataset.iris().xy zoo_folder = os.path.join(logging_folder, f\"__{model}__\") zoo = cflearn.Zoo(model) for key, config in zoo.benchmarks.items():",
"= \"__test_zoo__\" class TestZoo(unittest.TestCase... |
[
"the unsorted list at the midpoint into sublists. Takes O(k log n) quasilinear",
"the linked list into sublists containing a single node - Repeatedly merge the",
"right_head.next_node # Move current to next node current = current.next_node # Discard fake",
"set loop condition to False right_head = right_head.... |
[
"TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.",
"k, 10)) # Create engine engine_rbps = Engine(DIM, lshashes=hashes, distance=CosineDistance()) # First index",
"EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,",
"= numpy.rand... |
[
"print(discord.__version__) # discord.pyのバージョン print('----------------') print('Hello World !!') await self.change_presence(status=discord.Status.idle,activity=discord.Game(name=f'Ping:{self.ws.latency * 1000:.0f}ms')) conn=r.connect() ky=conn.keys()",
"discord.pyのバージョン print('----------------') print('Hello Worl... |
[
"# The package used for creating and manipulating HDF5 files: import h5py #",
"# Import packages # Ensure that this code works on both python 2",
"files: # finally import pycroscopy: try: import pycroscopy as px except ImportError: print('pycroscopy",
"method to determine the types of spectral responses prese... |
[
"TestCase from unittest.mock import Mock from unittest.mock import patch from foliant.config.downloadfile import download_file",
"= get_file_ext_from_url(url) self.assertEqual(ext, '.txt') def test_no_ext(self): url = 'http://example.com/sub/myfile' ext = get_file_ext_from_url(url) self.assertEqual(ext,",
"unit... |
[
"idが0以外なら匿名質問する if target_channel_id == 0: dm = await message.author.create_dm() # 質問者へDM作成 await dm.send(",
"チャンネルに質問メッセージ送信 await target_channel.send(question) # 匿名質問させたいチャンネルのidを取得 # 指定したカテゴリにある最初のTextチャンネル＝質問させたいチャンネルとみなす # ただしカテゴリにチャンネルが無い時は0を返す def getTargetChannelId() -> int:",
"discord.Client() # 接続に使用す... |
[
"max cell count if any(data_t >= 1): survive_count += 1 if counts_total is",
"at least 10% of the max cell count if any(data_t >= 1): survive_count",
"exp_info.populations[0] ax = ax.reshape((len(k_abs),)) axnum = 0 tc_axes=[] drug_axes=[] for exp in exp_folders:",
"== k_abs_t) num = num[0,0] # generate timec... |
[
"about the specific entry point.\"\"\" assert isinstance(function, types.FunctionType), \"fix that!\" from rpython.annotator.policy import",
"i)): new_ops = op.transform(self) if new_ops is not None: block.operations[i:i+1] = new_ops if",
"for # which it is fine to always raise an exception. We then",
"= self... |
[
"'type': '{object}'}, 'show_on_deleted_work_item': {'key': 'showOnDeletedWorkItem', 'type': 'bool'} } def __init__(self, contribution_id=None, height=None, inputs=None,",
"inherited=None, is_contribution=None, label=None, order=None, overridden=None, visible=None): super(Group, self).__init__() self.contribution ... |
[
"from utils import LogMixin class Reponse(object): __metaclass__ = abc.ABCMeta @abc.abstractmethod def redis(self): \"\"\"",
"= self.redis.mget(('inverse:index:movie:{}'.format(idx) for idx in movies)) response = [] for movie in movies:",
"@abc.abstractmethod def fetch(self, ids): \"\"\" hydrate relevant ids wi... |
[
"# This magically adds REPOSITORY_NAME/PACKAGE_NAME/{name_pb} to PYTHONPATH imports = [name_pb], visibility = visibility,",
"kwargs.get(\"name\") deps = kwargs.get(\"deps\") verbose = kwargs.get(\"verbose\") visibility = kwargs.get(\"visibility\") name_pb = name",
"name + \"_pb\" py_grpc_compile( name = name_pb... |
[
"the copyright holders nor the names of its # contributors may be used",
"# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A",
"machine: machine.addType(new_type) self.symtab.newSymbol(new_type) self.symtab.pushFrame() # Add all of the fields of the type",
"ANY # THEORY OF LIABILITY, ... |