repository_name
stringlengths
5
67
func_path_in_repository
stringlengths
4
234
func_name
stringlengths
0
314
whole_func_string
stringlengths
52
3.87M
language
stringclasses
6 values
func_code_string
stringlengths
52
3.87M
func_documentation_string
stringlengths
1
47.2k
func_code_url
stringlengths
85
339
abw333/dominoes
dominoes/game.py
_remaining_points
def _remaining_points(hands): ''' :param list hands: hands for which to compute the remaining points :return: a list indicating the amount of points remaining in each of the input hands ''' points = [] for hand in hands: points.append(sum(d.first + d.second for d in hand)) return points
python
def _remaining_points(hands): ''' :param list hands: hands for which to compute the remaining points :return: a list indicating the amount of points remaining in each of the input hands ''' points = [] for hand in hands: points.append(sum(d.first + d.second for d in hand)) return points
:param list hands: hands for which to compute the remaining points :return: a list indicating the amount of points remaining in each of the input hands
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L43-L53
abw333/dominoes
dominoes/game.py
_validate_hands
def _validate_hands(hands, missing): ''' Validates hands, based on values that are supposed to be missing from them. :param list hands: list of Hand objects to validate :param list missing: list of sets that indicate the values that are supposed to be missing from the respective Hand objects :return: True if no Hand objects contain values that they are supposed to be missing; False otherwise ''' for h, m in zip(hands, missing): for value in m: if dominoes.hand.contains_value(h, value): return False return True
python
def _validate_hands(hands, missing): ''' Validates hands, based on values that are supposed to be missing from them. :param list hands: list of Hand objects to validate :param list missing: list of sets that indicate the values that are supposed to be missing from the respective Hand objects :return: True if no Hand objects contain values that they are supposed to be missing; False otherwise ''' for h, m in zip(hands, missing): for value in m: if dominoes.hand.contains_value(h, value): return False return True
Validates hands, based on values that are supposed to be missing from them. :param list hands: list of Hand objects to validate :param list missing: list of sets that indicate the values that are supposed to be missing from the respective Hand objects :return: True if no Hand objects contain values that they are supposed to be missing; False otherwise
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L55-L72
abw333/dominoes
dominoes/game.py
_all_possible_partitionings
def _all_possible_partitionings(elements, sizes): ''' Helper function for Game.all_possible_hands(). Given a set of elements and the sizes of partitions, yields all possible partitionings of the elements into partitions of the provided sizes. :param set elements: a set of elements to partition. :param list sizes: a list of sizes for the partitions. The sum of the sizes should equal the length of the set of elements. :yields: a tuple of tuples, each inner tuple corresponding to a partition. ''' try: # get the size of the current partition size = sizes[0] except IndexError: # base case: no more sizes left yield () return # don't include the current size in the recursive calls sizes = sizes[1:] # iterate over all possible partitions of the current size for partition in itertools.combinations(elements, size): # recursive case: pass down the remaining elements and the remaining sizes for other_partitions in _all_possible_partitionings(elements.difference(partition), sizes): # put results together and yield up yield (partition,) + other_partitions
python
def _all_possible_partitionings(elements, sizes): ''' Helper function for Game.all_possible_hands(). Given a set of elements and the sizes of partitions, yields all possible partitionings of the elements into partitions of the provided sizes. :param set elements: a set of elements to partition. :param list sizes: a list of sizes for the partitions. The sum of the sizes should equal the length of the set of elements. :yields: a tuple of tuples, each inner tuple corresponding to a partition. ''' try: # get the size of the current partition size = sizes[0] except IndexError: # base case: no more sizes left yield () return # don't include the current size in the recursive calls sizes = sizes[1:] # iterate over all possible partitions of the current size for partition in itertools.combinations(elements, size): # recursive case: pass down the remaining elements and the remaining sizes for other_partitions in _all_possible_partitionings(elements.difference(partition), sizes): # put results together and yield up yield (partition,) + other_partitions
Helper function for Game.all_possible_hands(). Given a set of elements and the sizes of partitions, yields all possible partitionings of the elements into partitions of the provided sizes. :param set elements: a set of elements to partition. :param list sizes: a list of sizes for the partitions. The sum of the sizes should equal the length of the set of elements. :yields: a tuple of tuples, each inner tuple corresponding to a partition.
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L74-L101
abw333/dominoes
dominoes/game.py
Game.new
def new(cls, starting_domino=None, starting_player=0): ''' :param Domino starting_domino: the domino that should be played to start the game. The player with this domino in their hand will play first. :param int starting_player: the player that should play first. This value is ignored if a starting domino is provided. Players are referred to by their indexes: 0, 1, 2, and 3. 0 and 2 are on one team, and 1 and 3 are on another team. :return: a new game, initialized according to starting_domino and starting_player :raises NoSuchDominoException: if starting_domino is invalid :raises NoSuchPlayerException: if starting_player is invalid ''' board = dominoes.Board() hands = _randomized_hands() moves = [] result = None if starting_domino is None: _validate_player(starting_player) valid_moves = tuple((d, True) for d in hands[starting_player]) game = cls(board, hands, moves, starting_player, valid_moves, starting_player, result) else: starting_player = _domino_hand(starting_domino, hands) valid_moves = ((starting_domino, True),) game = cls(board, hands, moves, starting_player, valid_moves, starting_player, result) game.make_move(*valid_moves[0]) return game
python
def new(cls, starting_domino=None, starting_player=0): ''' :param Domino starting_domino: the domino that should be played to start the game. The player with this domino in their hand will play first. :param int starting_player: the player that should play first. This value is ignored if a starting domino is provided. Players are referred to by their indexes: 0, 1, 2, and 3. 0 and 2 are on one team, and 1 and 3 are on another team. :return: a new game, initialized according to starting_domino and starting_player :raises NoSuchDominoException: if starting_domino is invalid :raises NoSuchPlayerException: if starting_player is invalid ''' board = dominoes.Board() hands = _randomized_hands() moves = [] result = None if starting_domino is None: _validate_player(starting_player) valid_moves = tuple((d, True) for d in hands[starting_player]) game = cls(board, hands, moves, starting_player, valid_moves, starting_player, result) else: starting_player = _domino_hand(starting_domino, hands) valid_moves = ((starting_domino, True),) game = cls(board, hands, moves, starting_player, valid_moves, starting_player, result) game.make_move(*valid_moves[0]) return game
:param Domino starting_domino: the domino that should be played to start the game. The player with this domino in their hand will play first. :param int starting_player: the player that should play first. This value is ignored if a starting domino is provided. Players are referred to by their indexes: 0, 1, 2, and 3. 0 and 2 are on one team, and 1 and 3 are on another team. :return: a new game, initialized according to starting_domino and starting_player :raises NoSuchDominoException: if starting_domino is invalid :raises NoSuchPlayerException: if starting_player is invalid
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L236-L273
abw333/dominoes
dominoes/game.py
Game._update_valid_moves
def _update_valid_moves(self): ''' Updates self.valid_moves according to the latest game state. Assumes that the board and all hands are non-empty. ''' left_end = self.board.left_end() right_end = self.board.right_end() moves = [] for d in self.hands[self.turn]: if left_end in d: moves.append((d, True)) # do not double count moves if both of the board's ends have # the same value, and a domino can be placed on both of them if right_end in d and left_end != right_end: moves.append((d, False)) self.valid_moves = tuple(moves)
python
def _update_valid_moves(self): ''' Updates self.valid_moves according to the latest game state. Assumes that the board and all hands are non-empty. ''' left_end = self.board.left_end() right_end = self.board.right_end() moves = [] for d in self.hands[self.turn]: if left_end in d: moves.append((d, True)) # do not double count moves if both of the board's ends have # the same value, and a domino can be placed on both of them if right_end in d and left_end != right_end: moves.append((d, False)) self.valid_moves = tuple(moves)
Updates self.valid_moves according to the latest game state. Assumes that the board and all hands are non-empty.
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L284-L301
abw333/dominoes
dominoes/game.py
Game.make_move
def make_move(self, d, left): ''' Plays a domino from the hand of the player whose turn it is onto one end of the game board. If the game does not end, the turn is advanced to the next player who has a valid move. Making a move is transactional - if the operation fails at any point, the game will return to its state before the operation began. :param Domino d: domino to be played :param bool left: end of the board on which to play the domino (True for left, False for right) :return: a Result object if the game ends; None otherwise :raises GameOverException: if the game has already ended :raises NoSuchDominoException: if the domino to be played is not in the hand of the player whose turn it is :raises EndsMismatchException: if the domino cannot be placed on the specified position in the board ''' if self.result is not None: raise dominoes.GameOverException('Cannot make a move - the game is over!') i = self.hands[self.turn].play(d) try: self.board.add(d, left) except dominoes.EndsMismatchException as error: # return the domino to the hand if it cannot be placed on the board self.hands[self.turn].draw(d, i) raise error # record the move self.moves.append((d, left)) # check if the game ended due to a player running out of dominoes if not self.hands[self.turn]: self.valid_moves = () self.result = dominoes.Result( self.turn, True, pow(-1, self.turn) * sum(_remaining_points(self.hands)) ) return self.result # advance the turn to the next player with a valid move. # if no player has a valid move, the game is stuck. also, # record all the passes. passes = [] stuck = True for _ in self.hands: self.turn = next_player(self.turn) self._update_valid_moves() if self.valid_moves: self.moves.extend(passes) stuck = False break else: passes.append(None) if stuck: player_points = _remaining_points(self.hands) team_points = [player_points[0] + player_points[2], player_points[1] + player_points[3]] if team_points[0] < team_points[1]: self.result = dominoes.Result(self.turn, False, sum(team_points)) elif team_points[0] == team_points[1]: self.result = dominoes.Result(self.turn, False, 0) else: self.result = dominoes.Result(self.turn, False, -sum(team_points)) return self.result
python
def make_move(self, d, left): ''' Plays a domino from the hand of the player whose turn it is onto one end of the game board. If the game does not end, the turn is advanced to the next player who has a valid move. Making a move is transactional - if the operation fails at any point, the game will return to its state before the operation began. :param Domino d: domino to be played :param bool left: end of the board on which to play the domino (True for left, False for right) :return: a Result object if the game ends; None otherwise :raises GameOverException: if the game has already ended :raises NoSuchDominoException: if the domino to be played is not in the hand of the player whose turn it is :raises EndsMismatchException: if the domino cannot be placed on the specified position in the board ''' if self.result is not None: raise dominoes.GameOverException('Cannot make a move - the game is over!') i = self.hands[self.turn].play(d) try: self.board.add(d, left) except dominoes.EndsMismatchException as error: # return the domino to the hand if it cannot be placed on the board self.hands[self.turn].draw(d, i) raise error # record the move self.moves.append((d, left)) # check if the game ended due to a player running out of dominoes if not self.hands[self.turn]: self.valid_moves = () self.result = dominoes.Result( self.turn, True, pow(-1, self.turn) * sum(_remaining_points(self.hands)) ) return self.result # advance the turn to the next player with a valid move. # if no player has a valid move, the game is stuck. also, # record all the passes. passes = [] stuck = True for _ in self.hands: self.turn = next_player(self.turn) self._update_valid_moves() if self.valid_moves: self.moves.extend(passes) stuck = False break else: passes.append(None) if stuck: player_points = _remaining_points(self.hands) team_points = [player_points[0] + player_points[2], player_points[1] + player_points[3]] if team_points[0] < team_points[1]: self.result = dominoes.Result(self.turn, False, sum(team_points)) elif team_points[0] == team_points[1]: self.result = dominoes.Result(self.turn, False, 0) else: self.result = dominoes.Result(self.turn, False, -sum(team_points)) return self.result
Plays a domino from the hand of the player whose turn it is onto one end of the game board. If the game does not end, the turn is advanced to the next player who has a valid move. Making a move is transactional - if the operation fails at any point, the game will return to its state before the operation began. :param Domino d: domino to be played :param bool left: end of the board on which to play the domino (True for left, False for right) :return: a Result object if the game ends; None otherwise :raises GameOverException: if the game has already ended :raises NoSuchDominoException: if the domino to be played is not in the hand of the player whose turn it is :raises EndsMismatchException: if the domino cannot be placed on the specified position in the board
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L303-L373
abw333/dominoes
dominoes/game.py
Game.missing_values
def missing_values(self): ''' Computes the values that must be missing from each player's hand, based on when they have passed. :return: a list of sets, each one containing the values that must be missing from the corresponding player's hand ''' missing = [set() for _ in self.hands] # replay the game from the beginning board = dominoes.SkinnyBoard() player = self.starting_player for move in self.moves: if move is None: # pass - update the missing values missing[player].update([board.left_end(), board.right_end()]) else: # not a pass - update the board board.add(*move) # move on to the next player player = next_player(player) return missing
python
def missing_values(self): ''' Computes the values that must be missing from each player's hand, based on when they have passed. :return: a list of sets, each one containing the values that must be missing from the corresponding player's hand ''' missing = [set() for _ in self.hands] # replay the game from the beginning board = dominoes.SkinnyBoard() player = self.starting_player for move in self.moves: if move is None: # pass - update the missing values missing[player].update([board.left_end(), board.right_end()]) else: # not a pass - update the board board.add(*move) # move on to the next player player = next_player(player) return missing
Computes the values that must be missing from each player's hand, based on when they have passed. :return: a list of sets, each one containing the values that must be missing from the corresponding player's hand
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L375-L400
abw333/dominoes
dominoes/game.py
Game.random_possible_hands
def random_possible_hands(self): ''' Returns random possible hands for all players, given the information known by the player whose turn it is. This information includes the current player's hand, the sizes of the other players' hands, and the moves played by every player, including the passes. :return: a list of possible Hand objects, corresponding to each player ''' # compute values that must be missing from # each hand, to rule out impossible hands missing = self.missing_values() # get the dominoes that are in all of the other hands. note that, even # though we are 'looking' at the other hands to get these dominoes, we # are not 'cheating' because these dominoes could also be computed by # subtracting the dominoes that have been played (which are public # knowledge) and the dominoes in the current player's hand from the # initial set of dominoes other_dominoes = [d for p, h in enumerate(self.hands) for d in h if p != self.turn] while True: # generator for a shuffled shallow copy of other_dominoes shuffled_dominoes = (d for d in random.sample(other_dominoes, len(other_dominoes))) # generate random hands by partitioning the shuffled dominoes according # to how many dominoes need to be in each of the other hands. since we # know the current player's hand, we just use a shallow copy of it hands = [] for player, hand in enumerate(self.hands): if player != self.turn: hand = [next(shuffled_dominoes) for _ in hand] hands.append(dominoes.Hand(hand)) # only return the hands if they are possible, according to the values we # know to be missing from each hand. if the hands are not possible, try # generating random hands again if _validate_hands(hands, missing): return hands
python
def random_possible_hands(self): ''' Returns random possible hands for all players, given the information known by the player whose turn it is. This information includes the current player's hand, the sizes of the other players' hands, and the moves played by every player, including the passes. :return: a list of possible Hand objects, corresponding to each player ''' # compute values that must be missing from # each hand, to rule out impossible hands missing = self.missing_values() # get the dominoes that are in all of the other hands. note that, even # though we are 'looking' at the other hands to get these dominoes, we # are not 'cheating' because these dominoes could also be computed by # subtracting the dominoes that have been played (which are public # knowledge) and the dominoes in the current player's hand from the # initial set of dominoes other_dominoes = [d for p, h in enumerate(self.hands) for d in h if p != self.turn] while True: # generator for a shuffled shallow copy of other_dominoes shuffled_dominoes = (d for d in random.sample(other_dominoes, len(other_dominoes))) # generate random hands by partitioning the shuffled dominoes according # to how many dominoes need to be in each of the other hands. since we # know the current player's hand, we just use a shallow copy of it hands = [] for player, hand in enumerate(self.hands): if player != self.turn: hand = [next(shuffled_dominoes) for _ in hand] hands.append(dominoes.Hand(hand)) # only return the hands if they are possible, according to the values we # know to be missing from each hand. if the hands are not possible, try # generating random hands again if _validate_hands(hands, missing): return hands
Returns random possible hands for all players, given the information known by the player whose turn it is. This information includes the current player's hand, the sizes of the other players' hands, and the moves played by every player, including the passes. :return: a list of possible Hand objects, corresponding to each player
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L402-L440
abw333/dominoes
dominoes/game.py
Game.all_possible_hands
def all_possible_hands(self): ''' Yields all possible hands for all players, given the information known by the player whose turn it is. This information includes the current player's hand, the sizes of the other players' hands, and the moves played by every player, including the passes. :yields: a list of possible Hand objects, corresponding to each player ''' # compute values that must be missing from # each hand, to rule out impossible hands missing = self.missing_values() # get the dominoes that are in all of the other hands. note that, even # though we are 'looking' at the other hands to get these dominoes, we # are not 'cheating' because these dominoes could also be computed by # subtracting the dominoes that have been played (which are public # knowledge) and the dominoes in the current player's hand from the # initial set of dominoes other_dominoes = {d for p, h in enumerate(self.hands) for d in h if p != self.turn} # get the lengths of all the other hands, so # that we know how many dominoes to place in each other_hand_lengths = [len(h) for p, h in enumerate(self.hands) if p != self.turn] # iterate over all possible hands that the other players might have for possible_hands in _all_possible_partitionings(other_dominoes, other_hand_lengths): # given possible hands for all players, this is a generator for # tuples containing the dominoes that are in the other players' hands possible_hands = (h for h in possible_hands) # build a list containing possible hands for all players. since we # know the current player's hand, we just use a shallow copy of it hands = [] for player, hand in enumerate(self.hands): if player != self.turn: hand = next(possible_hands) hands.append(dominoes.Hand(hand)) # only yield the hands if they are possible, according # to the values we know to be missing from each hand if _validate_hands(hands, missing): yield hands
python
def all_possible_hands(self): ''' Yields all possible hands for all players, given the information known by the player whose turn it is. This information includes the current player's hand, the sizes of the other players' hands, and the moves played by every player, including the passes. :yields: a list of possible Hand objects, corresponding to each player ''' # compute values that must be missing from # each hand, to rule out impossible hands missing = self.missing_values() # get the dominoes that are in all of the other hands. note that, even # though we are 'looking' at the other hands to get these dominoes, we # are not 'cheating' because these dominoes could also be computed by # subtracting the dominoes that have been played (which are public # knowledge) and the dominoes in the current player's hand from the # initial set of dominoes other_dominoes = {d for p, h in enumerate(self.hands) for d in h if p != self.turn} # get the lengths of all the other hands, so # that we know how many dominoes to place in each other_hand_lengths = [len(h) for p, h in enumerate(self.hands) if p != self.turn] # iterate over all possible hands that the other players might have for possible_hands in _all_possible_partitionings(other_dominoes, other_hand_lengths): # given possible hands for all players, this is a generator for # tuples containing the dominoes that are in the other players' hands possible_hands = (h for h in possible_hands) # build a list containing possible hands for all players. since we # know the current player's hand, we just use a shallow copy of it hands = [] for player, hand in enumerate(self.hands): if player != self.turn: hand = next(possible_hands) hands.append(dominoes.Hand(hand)) # only yield the hands if they are possible, according # to the values we know to be missing from each hand if _validate_hands(hands, missing): yield hands
Yields all possible hands for all players, given the information known by the player whose turn it is. This information includes the current player's hand, the sizes of the other players' hands, and the moves played by every player, including the passes. :yields: a list of possible Hand objects, corresponding to each player
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/game.py#L442-L484
abw333/dominoes
dominoes/players.py
random
def random(game): ''' Prefers moves randomly. :param Game game: game to play :return: None ''' game.valid_moves = tuple(sorted(game.valid_moves, key=lambda _: rand.random()))
python
def random(game): ''' Prefers moves randomly. :param Game game: game to play :return: None ''' game.valid_moves = tuple(sorted(game.valid_moves, key=lambda _: rand.random()))
Prefers moves randomly. :param Game game: game to play :return: None
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/players.py#L71-L78
abw333/dominoes
dominoes/players.py
bota_gorda
def bota_gorda(game): ''' Prefers to play dominoes with higher point values. :param Game game: game to play :return: None ''' game.valid_moves = tuple(sorted(game.valid_moves, key=lambda m: -(m[0].first + m[0].second)))
python
def bota_gorda(game): ''' Prefers to play dominoes with higher point values. :param Game game: game to play :return: None ''' game.valid_moves = tuple(sorted(game.valid_moves, key=lambda m: -(m[0].first + m[0].second)))
Prefers to play dominoes with higher point values. :param Game game: game to play :return: None
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/players.py#L89-L96
abw333/dominoes
dominoes/search.py
make_moves
def make_moves(game, player=dominoes.players.identity): ''' For each of a Game object's valid moves, yields a tuple containing the move and the Game object obtained by playing the move on the original Game object. The original Game object will be modified. :param Game game: the game to make moves on :param callable player: a player to call on the game before making any moves, to determine the order in which they get made. The identity player is the default. ''' # game is over - do not yield anything if game.result is not None: return # determine the order in which to make moves player(game) # copy the original game before making all # but the last move for move in game.valid_moves[:-1]: new_game = copy.deepcopy(game) new_game.make_move(*move) yield move, new_game # don't copy the original game before making # the last move move = game.valid_moves[-1] game.make_move(*move) yield move, game
python
def make_moves(game, player=dominoes.players.identity): ''' For each of a Game object's valid moves, yields a tuple containing the move and the Game object obtained by playing the move on the original Game object. The original Game object will be modified. :param Game game: the game to make moves on :param callable player: a player to call on the game before making any moves, to determine the order in which they get made. The identity player is the default. ''' # game is over - do not yield anything if game.result is not None: return # determine the order in which to make moves player(game) # copy the original game before making all # but the last move for move in game.valid_moves[:-1]: new_game = copy.deepcopy(game) new_game.make_move(*move) yield move, new_game # don't copy the original game before making # the last move move = game.valid_moves[-1] game.make_move(*move) yield move, game
For each of a Game object's valid moves, yields a tuple containing the move and the Game object obtained by playing the move on the original Game object. The original Game object will be modified. :param Game game: the game to make moves on :param callable player: a player to call on the game before making any moves, to determine the order in which they get made. The identity player is the default.
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/search.py#L5-L38
abw333/dominoes
dominoes/search.py
alphabeta
def alphabeta(game, alpha_beta=(-float('inf'), float('inf')), player=dominoes.players.identity): ''' Runs minimax search with alpha-beta pruning on the provided game. :param Game game: game to search :param tuple alpha_beta: a tuple of two floats that indicate the initial values of alpha and beta, respectively. The default is (-inf, inf). :param callable player: player used to sort moves to be explored. Ordering better moves first may significantly reduce the amount of moves that need to be explored. The identity player is the default. ''' # base case - game is over if game.result is not None: return [], game.result.points if game.turn % 2: # minimizing player best_value = float('inf') op = operator.lt update = lambda ab, v: (ab[0], min(ab[1], v)) else: # maximizing player best_value = -float('inf') op = operator.gt update = lambda ab, v: (max(ab[0], v), ab[1]) # recursive case - game is not over for move, new_game in make_moves(game, player): moves, value = alphabeta(new_game, alpha_beta, player) if op(value, best_value): best_value = value best_moves = moves best_moves.insert(0, move) alpha_beta = update(alpha_beta, best_value) if alpha_beta[1] <= alpha_beta[0]: # alpha-beta cutoff break return best_moves, best_value
python
def alphabeta(game, alpha_beta=(-float('inf'), float('inf')), player=dominoes.players.identity): ''' Runs minimax search with alpha-beta pruning on the provided game. :param Game game: game to search :param tuple alpha_beta: a tuple of two floats that indicate the initial values of alpha and beta, respectively. The default is (-inf, inf). :param callable player: player used to sort moves to be explored. Ordering better moves first may significantly reduce the amount of moves that need to be explored. The identity player is the default. ''' # base case - game is over if game.result is not None: return [], game.result.points if game.turn % 2: # minimizing player best_value = float('inf') op = operator.lt update = lambda ab, v: (ab[0], min(ab[1], v)) else: # maximizing player best_value = -float('inf') op = operator.gt update = lambda ab, v: (max(ab[0], v), ab[1]) # recursive case - game is not over for move, new_game in make_moves(game, player): moves, value = alphabeta(new_game, alpha_beta, player) if op(value, best_value): best_value = value best_moves = moves best_moves.insert(0, move) alpha_beta = update(alpha_beta, best_value) if alpha_beta[1] <= alpha_beta[0]: # alpha-beta cutoff break return best_moves, best_value
Runs minimax search with alpha-beta pruning on the provided game. :param Game game: game to search :param tuple alpha_beta: a tuple of two floats that indicate the initial values of alpha and beta, respectively. The default is (-inf, inf). :param callable player: player used to sort moves to be explored. Ordering better moves first may significantly reduce the amount of moves that need to be explored. The identity player is the default.
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/search.py#L40-L81
abw333/dominoes
dominoes/series.py
Series.next_game
def next_game(self): ''' Advances the series to the next game, if possible. Also updates each team's score with points from the most recently completed game. :return: the next game, if the previous game did not end the series; None otherwise :raises SeriesOverException: if the series has already ended :raises GameInProgressException: if the last game has not yet finished ''' if self.is_over(): raise dominoes.SeriesOverException( 'Cannot start a new game - series ended with a score of {} to {}'.format(*self.scores) ) result = self.games[-1].result if result is None: raise dominoes.GameInProgressException( 'Cannot start a new game - the latest one has not finished!' ) # update each team's score with the points from the previous game if result.points >= 0: self.scores[0] += result.points else: self.scores[1] -= result.points # return None if the series is now over if self.is_over(): return # determine the starting player for the next game if result.won or pow(-1, result.player) * result.points > 0: starting_player = result.player elif not result.points: starting_player = self.games[-1].starting_player else: # pow(-1, result.player) * result.points < 0 starting_player = dominoes.game.next_player(result.player) # start the next game self.games.append(dominoes.Game.new(starting_player=starting_player)) return self.games[-1]
python
def next_game(self): ''' Advances the series to the next game, if possible. Also updates each team's score with points from the most recently completed game. :return: the next game, if the previous game did not end the series; None otherwise :raises SeriesOverException: if the series has already ended :raises GameInProgressException: if the last game has not yet finished ''' if self.is_over(): raise dominoes.SeriesOverException( 'Cannot start a new game - series ended with a score of {} to {}'.format(*self.scores) ) result = self.games[-1].result if result is None: raise dominoes.GameInProgressException( 'Cannot start a new game - the latest one has not finished!' ) # update each team's score with the points from the previous game if result.points >= 0: self.scores[0] += result.points else: self.scores[1] -= result.points # return None if the series is now over if self.is_over(): return # determine the starting player for the next game if result.won or pow(-1, result.player) * result.points > 0: starting_player = result.player elif not result.points: starting_player = self.games[-1].starting_player else: # pow(-1, result.player) * result.points < 0 starting_player = dominoes.game.next_player(result.player) # start the next game self.games.append(dominoes.Game.new(starting_player=starting_player)) return self.games[-1]
Advances the series to the next game, if possible. Also updates each team's score with points from the most recently completed game. :return: the next game, if the previous game did not end the series; None otherwise :raises SeriesOverException: if the series has already ended :raises GameInProgressException: if the last game has not yet finished
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/series.py#L92-L134
abw333/dominoes
dominoes/skinny_board.py
SkinnyBoard.from_board
def from_board(cls, board): ''' :param Board board: board to represent :return: SkinnyBoard to represent the given Board ''' if len(board): left = board.left_end() right = board.right_end() else: left = None right = None return cls(left, right, len(board))
python
def from_board(cls, board): ''' :param Board board: board to represent :return: SkinnyBoard to represent the given Board ''' if len(board): left = board.left_end() right = board.right_end() else: left = None right = None return cls(left, right, len(board))
:param Board board: board to represent :return: SkinnyBoard to represent the given Board
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/skinny_board.py#L44-L56
abw333/dominoes
dominoes/skinny_board.py
SkinnyBoard._add_left
def _add_left(self, d): ''' Adds the provided domino to the left end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self._left = d.first self._right = d.second elif d.second == self.left_end(): self._left = d.first elif d.first == self.left_end(): self._left = d.second else: raise dominoes.EndsMismatchException( '{} cannot be added to the left of' ' the board - values do not match!'.format(d) ) self._length += 1
python
def _add_left(self, d): ''' Adds the provided domino to the left end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self._left = d.first self._right = d.second elif d.second == self.left_end(): self._left = d.first elif d.first == self.left_end(): self._left = d.second else: raise dominoes.EndsMismatchException( '{} cannot be added to the left of' ' the board - values do not match!'.format(d) ) self._length += 1
Adds the provided domino to the left end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/skinny_board.py#L80-L101
abw333/dominoes
dominoes/skinny_board.py
SkinnyBoard._add_right
def _add_right(self, d): ''' Adds the provided domino to the right end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self._left = d.first self._right = d.second elif d.first == self.right_end(): self._right = d.second elif d.second == self.right_end(): self._right = d.first else: raise dominoes.EndsMismatchException( '{} cannot be added to the right of' ' the board - values do not match!'.format(d) ) self._length += 1
python
def _add_right(self, d): ''' Adds the provided domino to the right end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self._left = d.first self._right = d.second elif d.first == self.right_end(): self._right = d.second elif d.second == self.right_end(): self._right = d.first else: raise dominoes.EndsMismatchException( '{} cannot be added to the right of' ' the board - values do not match!'.format(d) ) self._length += 1
Adds the provided domino to the right end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/skinny_board.py#L103-L124
abw333/dominoes
dominoes/skinny_board.py
SkinnyBoard.add
def add(self, d, left): ''' Adds the provided domino to the specifed end of the board. :param Domino d: domino to add :param bool left: end of the board to which to add the domino (True for left, False for right) :return: None :raises EndsMismatchException: if the values do not match ''' if left: self._add_left(d) else: self._add_right(d)
python
def add(self, d, left): ''' Adds the provided domino to the specifed end of the board. :param Domino d: domino to add :param bool left: end of the board to which to add the domino (True for left, False for right) :return: None :raises EndsMismatchException: if the values do not match ''' if left: self._add_left(d) else: self._add_right(d)
Adds the provided domino to the specifed end of the board. :param Domino d: domino to add :param bool left: end of the board to which to add the domino (True for left, False for right) :return: None :raises EndsMismatchException: if the values do not match
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/skinny_board.py#L126-L139
abw333/dominoes
dominoes/board.py
Board._add_left
def _add_left(self, d): ''' Adds the provided domino to the left end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self.board.append(d) elif d.first == self.left_end(): self.board.appendleft(d.inverted()) elif d.second == self.left_end(): self.board.appendleft(d) else: raise dominoes.EndsMismatchException( '{} cannot be added to the left of' ' the board - values do not match!'.format(d) )
python
def _add_left(self, d): ''' Adds the provided domino to the left end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self.board.append(d) elif d.first == self.left_end(): self.board.appendleft(d.inverted()) elif d.second == self.left_end(): self.board.appendleft(d) else: raise dominoes.EndsMismatchException( '{} cannot be added to the left of' ' the board - values do not match!'.format(d) )
Adds the provided domino to the left end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/board.py#L60-L78
abw333/dominoes
dominoes/board.py
Board._add_right
def _add_right(self, d): ''' Adds the provided domino to the right end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self.board.append(d) elif d.first == self.right_end(): self.board.append(d) elif d.second == self.right_end(): self.board.append(d.inverted()) else: raise dominoes.EndsMismatchException( '{} cannot be added to the right of' ' the board - values do not match!'.format(d) )
python
def _add_right(self, d): ''' Adds the provided domino to the right end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match ''' if not self: self.board.append(d) elif d.first == self.right_end(): self.board.append(d) elif d.second == self.right_end(): self.board.append(d.inverted()) else: raise dominoes.EndsMismatchException( '{} cannot be added to the right of' ' the board - values do not match!'.format(d) )
Adds the provided domino to the right end of the board. :param Domino d: domino to add :return: None :raises EndsMismatchException: if the values do not match
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/board.py#L80-L98
abw333/dominoes
dominoes/hand.py
Hand.play
def play(self, d): ''' Removes a domino from the hand. :param Domino d: domino to remove from the hand :return: the index within the hand of the played domino :raises NoSuchDominoException: if the domino is not in the hand ''' try: i = self._dominoes.index(d) except ValueError: raise dominoes.NoSuchDominoException('Cannot make move -' ' {} is not in hand!'.format(d)) self._dominoes.pop(i) return i
python
def play(self, d): ''' Removes a domino from the hand. :param Domino d: domino to remove from the hand :return: the index within the hand of the played domino :raises NoSuchDominoException: if the domino is not in the hand ''' try: i = self._dominoes.index(d) except ValueError: raise dominoes.NoSuchDominoException('Cannot make move -' ' {} is not in hand!'.format(d)) self._dominoes.pop(i) return i
Removes a domino from the hand. :param Domino d: domino to remove from the hand :return: the index within the hand of the played domino :raises NoSuchDominoException: if the domino is not in the hand
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/hand.py#L46-L61
abw333/dominoes
dominoes/hand.py
Hand.draw
def draw(self, d, i=None): ''' Adds a domino to the hand. :param Domino d: domino to add to the hand :param int i: index at which to add the domino; by default adds to the end of the hand :return: None ''' if i is None: self._dominoes.append(d) else: self._dominoes.insert(i, d)
python
def draw(self, d, i=None): ''' Adds a domino to the hand. :param Domino d: domino to add to the hand :param int i: index at which to add the domino; by default adds to the end of the hand :return: None ''' if i is None: self._dominoes.append(d) else: self._dominoes.insert(i, d)
Adds a domino to the hand. :param Domino d: domino to add to the hand :param int i: index at which to add the domino; by default adds to the end of the hand :return: None
https://github.com/abw333/dominoes/blob/ea9f532c9b834117a5c07d214711515872f7537e/dominoes/hand.py#L63-L75
albertz/music-player-core
compile_utils.py
find_exec_in_path
def find_exec_in_path(exec_name): """ :param str exec_name: :return: yields full paths :rtype: list[str] """ if "PATH" not in os.environ: return for p in os.environ["PATH"].split(":"): pp = "%s/%s" % (p, exec_name) if os.path.exists(pp): yield pp
python
def find_exec_in_path(exec_name): """ :param str exec_name: :return: yields full paths :rtype: list[str] """ if "PATH" not in os.environ: return for p in os.environ["PATH"].split(":"): pp = "%s/%s" % (p, exec_name) if os.path.exists(pp): yield pp
:param str exec_name: :return: yields full paths :rtype: list[str]
https://github.com/albertz/music-player-core/blob/d124f8b43362648501d157a67d203d5f4ef008ad/compile_utils.py#L165-L176
albertz/music-player-core
compile_utils.py
get_pkg_config
def get_pkg_config(pkg_config_args, *packages): """ :param str|list[str] pkg_config_args: e.g. "--cflags" :param str packages: e.g. "python3" :rtype: list[str]|None """ if not isinstance(pkg_config_args, (tuple, list)): pkg_config_args = [pkg_config_args] # Maybe we have multiple pkg-config, and maybe some of them finds it. for pp in find_exec_in_path("pkg-config"): try: cmd = [pp] + list(pkg_config_args) + list(packages) #print(" ".join(cmd)) out = check_output(cmd, stderr=open(os.devnull, "wb")) return out.strip().decode("utf8").split() except CalledProcessError: pass return None
python
def get_pkg_config(pkg_config_args, *packages): """ :param str|list[str] pkg_config_args: e.g. "--cflags" :param str packages: e.g. "python3" :rtype: list[str]|None """ if not isinstance(pkg_config_args, (tuple, list)): pkg_config_args = [pkg_config_args] # Maybe we have multiple pkg-config, and maybe some of them finds it. for pp in find_exec_in_path("pkg-config"): try: cmd = [pp] + list(pkg_config_args) + list(packages) #print(" ".join(cmd)) out = check_output(cmd, stderr=open(os.devnull, "wb")) return out.strip().decode("utf8").split() except CalledProcessError: pass return None
:param str|list[str] pkg_config_args: e.g. "--cflags" :param str packages: e.g. "python3" :rtype: list[str]|None
https://github.com/albertz/music-player-core/blob/d124f8b43362648501d157a67d203d5f4ef008ad/compile_utils.py#L179-L196
albertz/music-player-core
setup.py
pkgconfig
def pkgconfig(*packages, **kw): """ :param str packages: list like 'libavutil', 'libavformat', ... :rtype: dict[str] """ kw = kw.copy() flag_map = {'-I': 'include_dirs', '-L': 'library_dirs', '-l': 'libraries'} # kwargs of :class:`Extension` for token in check_output(["pkg-config", "--libs", "--cflags"] + list(packages)).split(): if token[:2] in flag_map: kw.setdefault(flag_map[token[:2]], []).append(token[2:]) else: # throw others to extra_link_args kw.setdefault('extra_link_args', []).append(token) return kw
python
def pkgconfig(*packages, **kw): """ :param str packages: list like 'libavutil', 'libavformat', ... :rtype: dict[str] """ kw = kw.copy() flag_map = {'-I': 'include_dirs', '-L': 'library_dirs', '-l': 'libraries'} # kwargs of :class:`Extension` for token in check_output(["pkg-config", "--libs", "--cflags"] + list(packages)).split(): if token[:2] in flag_map: kw.setdefault(flag_map[token[:2]], []).append(token[2:]) else: # throw others to extra_link_args kw.setdefault('extra_link_args', []).append(token) return kw
:param str packages: list like 'libavutil', 'libavformat', ... :rtype: dict[str]
https://github.com/albertz/music-player-core/blob/d124f8b43362648501d157a67d203d5f4ef008ad/setup.py#L11-L23
fitodic/centerline
centerline/io.py
create_centerlines
def create_centerlines(src, dst, density=0.5): """ Create centerlines and save the to an ESRI Shapefile. Reads polygons from the `src` ESRI Shapefile, creates Centerline objects with the specified `density` parameter and writes them to the `dst` ESRI Shapefile. Only Polygon features are converted to centerlines. Features of different types are skipped. Args: src (str): source ESRI Shapefile dst (str): destination ESRI Shapefile density (:obj:`float`, optional): the Centerline's density. Defaults to 0.5 (meters) Returns: None """ try: DST_DRIVER = get_ogr_driver(filepath=dst) except ValueError: raise with fiona.Env(): with fiona.open(src, mode='r') as source: SCHEMA = source.schema.copy() SCHEMA.update({'geometry': 'MultiLineString'}) with fiona.open( dst, mode='w', driver=DST_DRIVER.GetName(), schema=SCHEMA, crs=source.crs, encoding=source.encoding) as destination: for record in source: geom = record.get('geometry') input_geom = shape(geom) if not is_valid_geometry(geometry=input_geom): continue attributes = record.get('properties') try: centerline_obj = Centerline( input_geom=input_geom, interpolation_dist=density, **attributes ) except RuntimeError as err: logging.warning( "ignoring record that could not be processed: %s", err ) continue centerline_dict = { 'geometry': mapping(centerline_obj), 'properties': { k: v for k, v in centerline_obj.__dict__.items() if k in attributes.keys() } } destination.write(centerline_dict) return None
python
def create_centerlines(src, dst, density=0.5): """ Create centerlines and save the to an ESRI Shapefile. Reads polygons from the `src` ESRI Shapefile, creates Centerline objects with the specified `density` parameter and writes them to the `dst` ESRI Shapefile. Only Polygon features are converted to centerlines. Features of different types are skipped. Args: src (str): source ESRI Shapefile dst (str): destination ESRI Shapefile density (:obj:`float`, optional): the Centerline's density. Defaults to 0.5 (meters) Returns: None """ try: DST_DRIVER = get_ogr_driver(filepath=dst) except ValueError: raise with fiona.Env(): with fiona.open(src, mode='r') as source: SCHEMA = source.schema.copy() SCHEMA.update({'geometry': 'MultiLineString'}) with fiona.open( dst, mode='w', driver=DST_DRIVER.GetName(), schema=SCHEMA, crs=source.crs, encoding=source.encoding) as destination: for record in source: geom = record.get('geometry') input_geom = shape(geom) if not is_valid_geometry(geometry=input_geom): continue attributes = record.get('properties') try: centerline_obj = Centerline( input_geom=input_geom, interpolation_dist=density, **attributes ) except RuntimeError as err: logging.warning( "ignoring record that could not be processed: %s", err ) continue centerline_dict = { 'geometry': mapping(centerline_obj), 'properties': { k: v for k, v in centerline_obj.__dict__.items() if k in attributes.keys() } } destination.write(centerline_dict) return None
Create centerlines and save the to an ESRI Shapefile. Reads polygons from the `src` ESRI Shapefile, creates Centerline objects with the specified `density` parameter and writes them to the `dst` ESRI Shapefile. Only Polygon features are converted to centerlines. Features of different types are skipped. Args: src (str): source ESRI Shapefile dst (str): destination ESRI Shapefile density (:obj:`float`, optional): the Centerline's density. Defaults to 0.5 (meters) Returns: None
https://github.com/fitodic/centerline/blob/f27e7b1ecb77bd4da40093ab44754cbd3ec9f58b/centerline/io.py#L14-L83
fitodic/centerline
centerline/main.py
Centerline._create_centerline
def _create_centerline(self): """ Calculate the centerline of a polygon. Densifies the border of a polygon which is then represented by a Numpy array of points necessary for creating the Voronoi diagram. Once the diagram is created, the ridges located within the polygon are joined and returned. Returns: a union of lines that are located within the polygon. """ border = array(self.__densify_border()) vor = Voronoi(border) vertex = vor.vertices lst_lines = [] for j, ridge in enumerate(vor.ridge_vertices): if -1 not in ridge: line = LineString([ (vertex[ridge[0]][0] + self._minx, vertex[ridge[0]][1] + self._miny), (vertex[ridge[1]][0] + self._minx, vertex[ridge[1]][1] + self._miny)]) if line.within(self._input_geom) and len(line.coords[0]) > 1: lst_lines.append(line) nr_lines = len(lst_lines) if nr_lines < 2: raise RuntimeError(( "Number of produced ridges is too small: {}" ", this might be caused by too large interpolation distance." ).format(nr_lines)) return unary_union(lst_lines)
python
def _create_centerline(self): """ Calculate the centerline of a polygon. Densifies the border of a polygon which is then represented by a Numpy array of points necessary for creating the Voronoi diagram. Once the diagram is created, the ridges located within the polygon are joined and returned. Returns: a union of lines that are located within the polygon. """ border = array(self.__densify_border()) vor = Voronoi(border) vertex = vor.vertices lst_lines = [] for j, ridge in enumerate(vor.ridge_vertices): if -1 not in ridge: line = LineString([ (vertex[ridge[0]][0] + self._minx, vertex[ridge[0]][1] + self._miny), (vertex[ridge[1]][0] + self._minx, vertex[ridge[1]][1] + self._miny)]) if line.within(self._input_geom) and len(line.coords[0]) > 1: lst_lines.append(line) nr_lines = len(lst_lines) if nr_lines < 2: raise RuntimeError(( "Number of produced ridges is too small: {}" ", this might be caused by too large interpolation distance." ).format(nr_lines)) return unary_union(lst_lines)
Calculate the centerline of a polygon. Densifies the border of a polygon which is then represented by a Numpy array of points necessary for creating the Voronoi diagram. Once the diagram is created, the ridges located within the polygon are joined and returned. Returns: a union of lines that are located within the polygon.
https://github.com/fitodic/centerline/blob/f27e7b1ecb77bd4da40093ab44754cbd3ec9f58b/centerline/main.py#L62-L99
fitodic/centerline
centerline/main.py
Centerline.__densify_border
def __densify_border(self): """ Densify the border of a polygon. The border is densified by a given factor (by default: 0.5). The complexity of the polygon's geometry is evaluated in order to densify the borders of its interior rings as well. Returns: list: a list of points where each point is represented by a list of its reduced coordinates Example: [[X1, Y1], [X2, Y2], ..., [Xn, Yn] """ if isinstance(self._input_geom, MultiPolygon): polygons = [polygon for polygon in self._input_geom] else: polygons = [self._input_geom] points = [] for polygon in polygons: if len(polygon.interiors) == 0: exterior = LineString(polygon.exterior) points += self.__fixed_interpolation(exterior) else: exterior = LineString(polygon.exterior) points += self.__fixed_interpolation(exterior) for j in range(len(polygon.interiors)): interior = LineString(polygon.interiors[j]) points += self.__fixed_interpolation(interior) return points
python
def __densify_border(self): """ Densify the border of a polygon. The border is densified by a given factor (by default: 0.5). The complexity of the polygon's geometry is evaluated in order to densify the borders of its interior rings as well. Returns: list: a list of points where each point is represented by a list of its reduced coordinates Example: [[X1, Y1], [X2, Y2], ..., [Xn, Yn] """ if isinstance(self._input_geom, MultiPolygon): polygons = [polygon for polygon in self._input_geom] else: polygons = [self._input_geom] points = [] for polygon in polygons: if len(polygon.interiors) == 0: exterior = LineString(polygon.exterior) points += self.__fixed_interpolation(exterior) else: exterior = LineString(polygon.exterior) points += self.__fixed_interpolation(exterior) for j in range(len(polygon.interiors)): interior = LineString(polygon.interiors[j]) points += self.__fixed_interpolation(interior) return points
Densify the border of a polygon. The border is densified by a given factor (by default: 0.5). The complexity of the polygon's geometry is evaluated in order to densify the borders of its interior rings as well. Returns: list: a list of points where each point is represented by a list of its reduced coordinates Example: [[X1, Y1], [X2, Y2], ..., [Xn, Yn]
https://github.com/fitodic/centerline/blob/f27e7b1ecb77bd4da40093ab44754cbd3ec9f58b/centerline/main.py#L101-L137
fitodic/centerline
centerline/main.py
Centerline.__fixed_interpolation
def __fixed_interpolation(self, line): """ Place additional points on the border at the specified distance. By default the distance is 0.5 (meters) which means that the first point will be placed 0.5 m from the starting point, the second point will be placed at the distance of 1.0 m from the first point, etc. The loop breaks when the summarized distance exceeds the length of the line. Args: line (shapely.geometry.LineString): object Returns: list: a list of points where each point is represented by a list of its reduced coordinates Example: [[X1, Y1], [X2, Y2], ..., [Xn, Yn] """ STARTPOINT = [line.xy[0][0] - self._minx, line.xy[1][0] - self._miny] ENDPOINT = [line.xy[0][-1] - self._minx, line.xy[1][-1] - self._miny] count = self._interpolation_dist newline = [STARTPOINT] while count < line.length: point = line.interpolate(count) newline.append([point.x - self._minx, point.y - self._miny]) count += self._interpolation_dist newline.append(ENDPOINT) return newline
python
def __fixed_interpolation(self, line): """ Place additional points on the border at the specified distance. By default the distance is 0.5 (meters) which means that the first point will be placed 0.5 m from the starting point, the second point will be placed at the distance of 1.0 m from the first point, etc. The loop breaks when the summarized distance exceeds the length of the line. Args: line (shapely.geometry.LineString): object Returns: list: a list of points where each point is represented by a list of its reduced coordinates Example: [[X1, Y1], [X2, Y2], ..., [Xn, Yn] """ STARTPOINT = [line.xy[0][0] - self._minx, line.xy[1][0] - self._miny] ENDPOINT = [line.xy[0][-1] - self._minx, line.xy[1][-1] - self._miny] count = self._interpolation_dist newline = [STARTPOINT] while count < line.length: point = line.interpolate(count) newline.append([point.x - self._minx, point.y - self._miny]) count += self._interpolation_dist newline.append(ENDPOINT) return newline
Place additional points on the border at the specified distance. By default the distance is 0.5 (meters) which means that the first point will be placed 0.5 m from the starting point, the second point will be placed at the distance of 1.0 m from the first point, etc. The loop breaks when the summarized distance exceeds the length of the line. Args: line (shapely.geometry.LineString): object Returns: list: a list of points where each point is represented by a list of its reduced coordinates Example: [[X1, Y1], [X2, Y2], ..., [Xn, Yn]
https://github.com/fitodic/centerline/blob/f27e7b1ecb77bd4da40093ab44754cbd3ec9f58b/centerline/main.py#L139-L173
fitodic/centerline
centerline/utils.py
is_valid_geometry
def is_valid_geometry(geometry): """ Confirm that the geometry type is of type Polygon or MultiPolygon. Args: geometry (BaseGeometry): BaseGeometry instance (e.g. Polygon) Returns: bool """ if isinstance(geometry, Polygon) or isinstance(geometry, MultiPolygon): return True else: return False
python
def is_valid_geometry(geometry): """ Confirm that the geometry type is of type Polygon or MultiPolygon. Args: geometry (BaseGeometry): BaseGeometry instance (e.g. Polygon) Returns: bool """ if isinstance(geometry, Polygon) or isinstance(geometry, MultiPolygon): return True else: return False
Confirm that the geometry type is of type Polygon or MultiPolygon. Args: geometry (BaseGeometry): BaseGeometry instance (e.g. Polygon) Returns: bool
https://github.com/fitodic/centerline/blob/f27e7b1ecb77bd4da40093ab44754cbd3ec9f58b/centerline/utils.py#L17-L31
fitodic/centerline
centerline/utils.py
get_ogr_driver
def get_ogr_driver(filepath): """ Get the OGR driver from the provided file extension. Args: file_extension (str): file extension Returns: osgeo.ogr.Driver Raises: ValueError: no driver is found """ filename, file_extension = os.path.splitext(filepath) EXTENSION = file_extension[1:] ogr_driver_count = ogr.GetDriverCount() for idx in range(ogr_driver_count): driver = ogr.GetDriver(idx) driver_extension = driver.GetMetadataItem(str('DMD_EXTENSION')) or '' driver_extensions = driver.GetMetadataItem(str('DMD_EXTENSIONS')) or '' if EXTENSION == driver_extension or EXTENSION in driver_extensions: return driver else: msg = 'No driver found for the following file extension: {}'.format( EXTENSION) raise ValueError(msg)
python
def get_ogr_driver(filepath): """ Get the OGR driver from the provided file extension. Args: file_extension (str): file extension Returns: osgeo.ogr.Driver Raises: ValueError: no driver is found """ filename, file_extension = os.path.splitext(filepath) EXTENSION = file_extension[1:] ogr_driver_count = ogr.GetDriverCount() for idx in range(ogr_driver_count): driver = ogr.GetDriver(idx) driver_extension = driver.GetMetadataItem(str('DMD_EXTENSION')) or '' driver_extensions = driver.GetMetadataItem(str('DMD_EXTENSIONS')) or '' if EXTENSION == driver_extension or EXTENSION in driver_extensions: return driver else: msg = 'No driver found for the following file extension: {}'.format( EXTENSION) raise ValueError(msg)
Get the OGR driver from the provided file extension. Args: file_extension (str): file extension Returns: osgeo.ogr.Driver Raises: ValueError: no driver is found
https://github.com/fitodic/centerline/blob/f27e7b1ecb77bd4da40093ab44754cbd3ec9f58b/centerline/utils.py#L34-L63
marcolagi/quantulum
quantulum/regex.py
get_numwords
def get_numwords(): """Convert number words to integers in a given text.""" numwords = {'and': (1, 0), 'a': (1, 1), 'an': (1, 1)} for idx, word in enumerate(UNITS): numwords[word] = (1, idx) for idx, word in enumerate(TENS): numwords[word] = (1, idx * 10) for idx, word in enumerate(SCALES): numwords[word] = (10 ** (idx * 3 or 2), 0) all_numbers = ur'|'.join(ur'\b%s\b' % i for i in numwords.keys() if i) return all_numbers, numwords
python
def get_numwords(): """Convert number words to integers in a given text.""" numwords = {'and': (1, 0), 'a': (1, 1), 'an': (1, 1)} for idx, word in enumerate(UNITS): numwords[word] = (1, idx) for idx, word in enumerate(TENS): numwords[word] = (1, idx * 10) for idx, word in enumerate(SCALES): numwords[word] = (10 ** (idx * 3 or 2), 0) all_numbers = ur'|'.join(ur'\b%s\b' % i for i in numwords.keys() if i) return all_numbers, numwords
Convert number words to integers in a given text.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/regex.py#L23-L36
marcolagi/quantulum
quantulum/regex.py
get_units_regex
def get_units_regex(): """Build a compiled regex object.""" op_keys = sorted(OPERATORS.keys(), key=len, reverse=True) unit_keys = sorted(l.UNITS.keys(), key=len, reverse=True) symbol_keys = sorted(l.SYMBOLS.keys(), key=len, reverse=True) exponent = ur'(?:(?:\^?\-?[0-9%s]*)(?:\ cubed|\ squared)?)(?![a-zA-Z])' % \ SUPERSCRIPTS all_ops = '|'.join([r'%s' % re.escape(i) for i in op_keys]) all_units = '|'.join([ur'%s' % re.escape(i) for i in unit_keys]) all_symbols = '|'.join([ur'%s' % re.escape(i) for i in symbol_keys]) pattern = ur''' (?P<prefix>(?:%s)(?![a-zA-Z]))? # Currencies, mainly (?P<value>%s)-? # Number (?:(?P<operator1>%s)?(?P<unit1>(?:%s)%s)?) # Operator + Unit (1) (?:(?P<operator2>%s)?(?P<unit2>(?:%s)%s)?) # Operator + Unit (2) (?:(?P<operator3>%s)?(?P<unit3>(?:%s)%s)?) # Operator + Unit (3) (?:(?P<operator4>%s)?(?P<unit4>(?:%s)%s)?) # Operator + Unit (4) ''' % tuple([all_symbols, RAN_PATTERN] + 4 * [all_ops, all_units, exponent]) regex = re.compile(pattern, re.VERBOSE | re.IGNORECASE) return regex
python
def get_units_regex(): """Build a compiled regex object.""" op_keys = sorted(OPERATORS.keys(), key=len, reverse=True) unit_keys = sorted(l.UNITS.keys(), key=len, reverse=True) symbol_keys = sorted(l.SYMBOLS.keys(), key=len, reverse=True) exponent = ur'(?:(?:\^?\-?[0-9%s]*)(?:\ cubed|\ squared)?)(?![a-zA-Z])' % \ SUPERSCRIPTS all_ops = '|'.join([r'%s' % re.escape(i) for i in op_keys]) all_units = '|'.join([ur'%s' % re.escape(i) for i in unit_keys]) all_symbols = '|'.join([ur'%s' % re.escape(i) for i in symbol_keys]) pattern = ur''' (?P<prefix>(?:%s)(?![a-zA-Z]))? # Currencies, mainly (?P<value>%s)-? # Number (?:(?P<operator1>%s)?(?P<unit1>(?:%s)%s)?) # Operator + Unit (1) (?:(?P<operator2>%s)?(?P<unit2>(?:%s)%s)?) # Operator + Unit (2) (?:(?P<operator3>%s)?(?P<unit3>(?:%s)%s)?) # Operator + Unit (3) (?:(?P<operator4>%s)?(?P<unit4>(?:%s)%s)?) # Operator + Unit (4) ''' % tuple([all_symbols, RAN_PATTERN] + 4 * [all_ops, all_units, exponent]) regex = re.compile(pattern, re.VERBOSE | re.IGNORECASE) return regex
Build a compiled regex object.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/regex.py#L105-L132
marcolagi/quantulum
quantulum/load.py
get_dimension_permutations
def get_dimension_permutations(entities, dimensions): """Get all possible dimensional definitions for an entity.""" new_dimensions = defaultdict(int) for item in dimensions: new = entities[item['base']].dimensions if new: for new_item in new: new_dimensions[new_item['base']] += new_item['power'] * \ item['power'] else: new_dimensions[item['base']] += item['power'] final = [[{'base': i[0], 'power': i[1]} for i in new_dimensions.items()]] final.append(dimensions) final = [sorted(i, key=lambda x: x['base']) for i in final] candidates = [] for item in final: if item not in candidates: candidates.append(item) return candidates
python
def get_dimension_permutations(entities, dimensions): """Get all possible dimensional definitions for an entity.""" new_dimensions = defaultdict(int) for item in dimensions: new = entities[item['base']].dimensions if new: for new_item in new: new_dimensions[new_item['base']] += new_item['power'] * \ item['power'] else: new_dimensions[item['base']] += item['power'] final = [[{'base': i[0], 'power': i[1]} for i in new_dimensions.items()]] final.append(dimensions) final = [sorted(i, key=lambda x: x['base']) for i in final] candidates = [] for item in final: if item not in candidates: candidates.append(item) return candidates
Get all possible dimensional definitions for an entity.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/load.py#L34-L55
marcolagi/quantulum
quantulum/load.py
load_entities
def load_entities(): """Load entities from JSON file.""" path = os.path.join(TOPDIR, 'entities.json') entities = json.load(open(path)) names = [i['name'] for i in entities] try: assert len(set(names)) == len(entities) except AssertionError: raise Exception('Entities with same name: %s' % [i for i in names if names.count(i) > 1]) entities = dict((k['name'], c.Entity(name=k['name'], dimensions=k['dimensions'], uri=k['URI'])) for k in entities) dimensions_ent = defaultdict(list) for ent in entities: if not entities[ent].dimensions: continue perms = get_dimension_permutations(entities, entities[ent].dimensions) for perm in perms: key = get_key_from_dimensions(perm) dimensions_ent[key].append(entities[ent]) return entities, dimensions_ent
python
def load_entities(): """Load entities from JSON file.""" path = os.path.join(TOPDIR, 'entities.json') entities = json.load(open(path)) names = [i['name'] for i in entities] try: assert len(set(names)) == len(entities) except AssertionError: raise Exception('Entities with same name: %s' % [i for i in names if names.count(i) > 1]) entities = dict((k['name'], c.Entity(name=k['name'], dimensions=k['dimensions'], uri=k['URI'])) for k in entities) dimensions_ent = defaultdict(list) for ent in entities: if not entities[ent].dimensions: continue perms = get_dimension_permutations(entities, entities[ent].dimensions) for perm in perms: key = get_key_from_dimensions(perm) dimensions_ent[key].append(entities[ent]) return entities, dimensions_ent
Load entities from JSON file.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/load.py#L59-L84
marcolagi/quantulum
quantulum/load.py
get_dimensions_units
def get_dimensions_units(names): """Create dictionary of unit dimensions.""" dimensions_uni = {} for name in names: key = get_key_from_dimensions(names[name].dimensions) dimensions_uni[key] = names[name] plain_dimensions = [{'base': name, 'power': 1}] key = get_key_from_dimensions(plain_dimensions) dimensions_uni[key] = names[name] if not names[name].dimensions: names[name].dimensions = plain_dimensions names[name].dimensions = [{'base': names[i['base']].name, 'power': i['power']} for i in names[name].dimensions] return dimensions_uni
python
def get_dimensions_units(names): """Create dictionary of unit dimensions.""" dimensions_uni = {} for name in names: key = get_key_from_dimensions(names[name].dimensions) dimensions_uni[key] = names[name] plain_dimensions = [{'base': name, 'power': 1}] key = get_key_from_dimensions(plain_dimensions) dimensions_uni[key] = names[name] if not names[name].dimensions: names[name].dimensions = plain_dimensions names[name].dimensions = [{'base': names[i['base']].name, 'power': i['power']} for i in names[name].dimensions] return dimensions_uni
Create dictionary of unit dimensions.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/load.py#L90-L109
marcolagi/quantulum
quantulum/load.py
load_units
def load_units(): """Load units from JSON file.""" names = {} lowers = defaultdict(list) symbols = defaultdict(list) surfaces = defaultdict(list) for unit in json.load(open(os.path.join(TOPDIR, 'units.json'))): try: assert unit['name'] not in names except AssertionError: msg = 'Two units with same name in units.json: %s' % unit['name'] raise Exception(msg) obj = c.Unit(name=unit['name'], surfaces=unit['surfaces'], entity=ENTITIES[unit['entity']], uri=unit['URI'], symbols=unit['symbols'], dimensions=unit['dimensions']) names[unit['name']] = obj for symbol in unit['symbols']: surfaces[symbol].append(obj) lowers[symbol.lower()].append(obj) if unit['entity'] == 'currency': symbols[symbol].append(obj) for surface in unit['surfaces']: surfaces[surface].append(obj) lowers[surface.lower()].append(obj) split = surface.split() index = None if ' per ' in surface: index = split.index('per') - 1 elif 'degree ' in surface: index = split.index('degree') if index is not None: plural = ' '.join([i if num != index else PLURALS.plural(split[index]) for num, i in enumerate(split)]) else: plural = PLURALS.plural(surface) if plural != surface: surfaces[plural].append(obj) lowers[plural.lower()].append(obj) dimensions_uni = get_dimensions_units(names) return names, surfaces, lowers, symbols, dimensions_uni
python
def load_units(): """Load units from JSON file.""" names = {} lowers = defaultdict(list) symbols = defaultdict(list) surfaces = defaultdict(list) for unit in json.load(open(os.path.join(TOPDIR, 'units.json'))): try: assert unit['name'] not in names except AssertionError: msg = 'Two units with same name in units.json: %s' % unit['name'] raise Exception(msg) obj = c.Unit(name=unit['name'], surfaces=unit['surfaces'], entity=ENTITIES[unit['entity']], uri=unit['URI'], symbols=unit['symbols'], dimensions=unit['dimensions']) names[unit['name']] = obj for symbol in unit['symbols']: surfaces[symbol].append(obj) lowers[symbol.lower()].append(obj) if unit['entity'] == 'currency': symbols[symbol].append(obj) for surface in unit['surfaces']: surfaces[surface].append(obj) lowers[surface.lower()].append(obj) split = surface.split() index = None if ' per ' in surface: index = split.index('per') - 1 elif 'degree ' in surface: index = split.index('degree') if index is not None: plural = ' '.join([i if num != index else PLURALS.plural(split[index]) for num, i in enumerate(split)]) else: plural = PLURALS.plural(surface) if plural != surface: surfaces[plural].append(obj) lowers[plural.lower()].append(obj) dimensions_uni = get_dimensions_units(names) return names, surfaces, lowers, symbols, dimensions_uni
Load units from JSON file.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/load.py#L113-L160
marcolagi/quantulum
quantulum/classifier.py
download_wiki
def download_wiki(): """Download WikiPedia pages of ambiguous units.""" ambiguous = [i for i in l.UNITS.items() if len(i[1]) > 1] ambiguous += [i for i in l.DERIVED_ENT.items() if len(i[1]) > 1] pages = set([(j.name, j.uri) for i in ambiguous for j in i[1]]) print objs = [] for num, page in enumerate(pages): obj = {'url': page[1]} obj['_id'] = obj['url'].replace('https://en.wikipedia.org/wiki/', '') obj['clean'] = obj['_id'].replace('_', ' ') print '---> Downloading %s (%d of %d)' % \ (obj['clean'], num + 1, len(pages)) obj['text'] = wikipedia.page(obj['clean']).content obj['unit'] = page[0] objs.append(obj) path = os.path.join(l.TOPDIR, 'wiki.json') os.remove(path) json.dump(objs, open(path, 'w'), indent=4, sort_keys=True) print '\n---> All done.\n'
python
def download_wiki(): """Download WikiPedia pages of ambiguous units.""" ambiguous = [i for i in l.UNITS.items() if len(i[1]) > 1] ambiguous += [i for i in l.DERIVED_ENT.items() if len(i[1]) > 1] pages = set([(j.name, j.uri) for i in ambiguous for j in i[1]]) print objs = [] for num, page in enumerate(pages): obj = {'url': page[1]} obj['_id'] = obj['url'].replace('https://en.wikipedia.org/wiki/', '') obj['clean'] = obj['_id'].replace('_', ' ') print '---> Downloading %s (%d of %d)' % \ (obj['clean'], num + 1, len(pages)) obj['text'] = wikipedia.page(obj['clean']).content obj['unit'] = page[0] objs.append(obj) path = os.path.join(l.TOPDIR, 'wiki.json') os.remove(path) json.dump(objs, open(path, 'w'), indent=4, sort_keys=True) print '\n---> All done.\n'
Download WikiPedia pages of ambiguous units.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/classifier.py#L28-L53
marcolagi/quantulum
quantulum/classifier.py
clean_text
def clean_text(text): """Clean text for TFIDF.""" new_text = re.sub(ur'\p{P}+', ' ', text) new_text = [stem(i) for i in new_text.lower().split() if not re.findall(r'[0-9]', i)] new_text = ' '.join(new_text) return new_text
python
def clean_text(text): """Clean text for TFIDF.""" new_text = re.sub(ur'\p{P}+', ' ', text) new_text = [stem(i) for i in new_text.lower().split() if not re.findall(r'[0-9]', i)] new_text = ' '.join(new_text) return new_text
Clean text for TFIDF.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/classifier.py#L57-L66
marcolagi/quantulum
quantulum/classifier.py
train_classifier
def train_classifier(download=True, parameters=None, ngram_range=(1, 1)): """Train the intent classifier.""" if download: download_wiki() path = os.path.join(l.TOPDIR, 'train.json') training_set = json.load(open(path)) path = os.path.join(l.TOPDIR, 'wiki.json') wiki_set = json.load(open(path)) target_names = list(set([i['unit'] for i in training_set + wiki_set])) train_data, train_target = [], [] for example in training_set + wiki_set: train_data.append(clean_text(example['text'])) train_target.append(target_names.index(example['unit'])) tfidf_model = TfidfVectorizer(sublinear_tf=True, ngram_range=ngram_range, stop_words='english') matrix = tfidf_model.fit_transform(train_data) if parameters is None: parameters = {'loss': 'log', 'penalty': 'l2', 'n_iter': 50, 'alpha': 0.00001, 'fit_intercept': True} clf = SGDClassifier(**parameters).fit(matrix, train_target) obj = {'tfidf_model': tfidf_model, 'clf': clf, 'target_names': target_names} path = os.path.join(l.TOPDIR, 'clf.pickle') pickle.dump(obj, open(path, 'w'))
python
def train_classifier(download=True, parameters=None, ngram_range=(1, 1)): """Train the intent classifier.""" if download: download_wiki() path = os.path.join(l.TOPDIR, 'train.json') training_set = json.load(open(path)) path = os.path.join(l.TOPDIR, 'wiki.json') wiki_set = json.load(open(path)) target_names = list(set([i['unit'] for i in training_set + wiki_set])) train_data, train_target = [], [] for example in training_set + wiki_set: train_data.append(clean_text(example['text'])) train_target.append(target_names.index(example['unit'])) tfidf_model = TfidfVectorizer(sublinear_tf=True, ngram_range=ngram_range, stop_words='english') matrix = tfidf_model.fit_transform(train_data) if parameters is None: parameters = {'loss': 'log', 'penalty': 'l2', 'n_iter': 50, 'alpha': 0.00001, 'fit_intercept': True} clf = SGDClassifier(**parameters).fit(matrix, train_target) obj = {'tfidf_model': tfidf_model, 'clf': clf, 'target_names': target_names} path = os.path.join(l.TOPDIR, 'clf.pickle') pickle.dump(obj, open(path, 'w'))
Train the intent classifier.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/classifier.py#L70-L101
marcolagi/quantulum
quantulum/classifier.py
load_classifier
def load_classifier(): """Train the intent classifier.""" path = os.path.join(l.TOPDIR, 'clf.pickle') obj = pickle.load(open(path, 'r')) return obj['tfidf_model'], obj['clf'], obj['target_names']
python
def load_classifier(): """Train the intent classifier.""" path = os.path.join(l.TOPDIR, 'clf.pickle') obj = pickle.load(open(path, 'r')) return obj['tfidf_model'], obj['clf'], obj['target_names']
Train the intent classifier.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/classifier.py#L105-L110
marcolagi/quantulum
quantulum/classifier.py
disambiguate_entity
def disambiguate_entity(key, text): """Resolve ambiguity between entities with same dimensionality.""" new_ent = l.DERIVED_ENT[key][0] if len(l.DERIVED_ENT[key]) > 1: transformed = TFIDF_MODEL.transform([text]) scores = CLF.predict_proba(transformed).tolist()[0] scores = sorted(zip(scores, TARGET_NAMES), key=lambda x: x[0], reverse=True) names = [i.name for i in l.DERIVED_ENT[key]] scores = [i for i in scores if i[1] in names] try: new_ent = l.ENTITIES[scores[0][1]] except IndexError: logging.debug('\tAmbiguity not resolved for "%s"', str(key)) return new_ent
python
def disambiguate_entity(key, text): """Resolve ambiguity between entities with same dimensionality.""" new_ent = l.DERIVED_ENT[key][0] if len(l.DERIVED_ENT[key]) > 1: transformed = TFIDF_MODEL.transform([text]) scores = CLF.predict_proba(transformed).tolist()[0] scores = sorted(zip(scores, TARGET_NAMES), key=lambda x: x[0], reverse=True) names = [i.name for i in l.DERIVED_ENT[key]] scores = [i for i in scores if i[1] in names] try: new_ent = l.ENTITIES[scores[0][1]] except IndexError: logging.debug('\tAmbiguity not resolved for "%s"', str(key)) return new_ent
Resolve ambiguity between entities with same dimensionality.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/classifier.py#L119-L135
marcolagi/quantulum
quantulum/classifier.py
disambiguate_unit
def disambiguate_unit(unit, text): """ Resolve ambiguity. Distinguish between units that have same names, symbols or abbreviations. """ new_unit = l.UNITS[unit] if not new_unit: new_unit = l.LOWER_UNITS[unit.lower()] if not new_unit: raise KeyError('Could not find unit "%s"' % unit) if len(new_unit) > 1: transformed = TFIDF_MODEL.transform([clean_text(text)]) scores = CLF.predict_proba(transformed).tolist()[0] scores = sorted(zip(scores, TARGET_NAMES), key=lambda x: x[0], reverse=True) names = [i.name for i in new_unit] scores = [i for i in scores if i[1] in names] try: final = l.UNITS[scores[0][1]][0] logging.debug('\tAmbiguity resolved for "%s" (%s)', unit, scores) except IndexError: logging.debug('\tAmbiguity not resolved for "%s"', unit) final = new_unit[0] else: final = new_unit[0] return final
python
def disambiguate_unit(unit, text): """ Resolve ambiguity. Distinguish between units that have same names, symbols or abbreviations. """ new_unit = l.UNITS[unit] if not new_unit: new_unit = l.LOWER_UNITS[unit.lower()] if not new_unit: raise KeyError('Could not find unit "%s"' % unit) if len(new_unit) > 1: transformed = TFIDF_MODEL.transform([clean_text(text)]) scores = CLF.predict_proba(transformed).tolist()[0] scores = sorted(zip(scores, TARGET_NAMES), key=lambda x: x[0], reverse=True) names = [i.name for i in new_unit] scores = [i for i in scores if i[1] in names] try: final = l.UNITS[scores[0][1]][0] logging.debug('\tAmbiguity resolved for "%s" (%s)', unit, scores) except IndexError: logging.debug('\tAmbiguity not resolved for "%s"', unit) final = new_unit[0] else: final = new_unit[0] return final
Resolve ambiguity. Distinguish between units that have same names, symbols or abbreviations.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/classifier.py#L139-L167
marcolagi/quantulum
quantulum/parser.py
clean_surface
def clean_surface(surface, span): """Remove spurious characters from a quantity's surface.""" surface = surface.replace('-', ' ') no_start = ['and', ' '] no_end = [' and', ' '] found = True while found: found = False for word in no_start: if surface.lower().startswith(word): surface = surface[len(word):] span = (span[0] + len(word), span[1]) found = True for word in no_end: if surface.lower().endswith(word): surface = surface[:-len(word)] span = (span[0], span[1] - len(word)) found = True if not surface: return None, None split = surface.lower().split() if split[0] in ['one', 'a', 'an'] and len(split) > 1 and split[1] in \ r.UNITS + r.TENS: span = (span[0] + len(surface.split()[0]) + 1, span[1]) surface = ' '.join(surface.split()[1:]) return surface, span
python
def clean_surface(surface, span): """Remove spurious characters from a quantity's surface.""" surface = surface.replace('-', ' ') no_start = ['and', ' '] no_end = [' and', ' '] found = True while found: found = False for word in no_start: if surface.lower().startswith(word): surface = surface[len(word):] span = (span[0] + len(word), span[1]) found = True for word in no_end: if surface.lower().endswith(word): surface = surface[:-len(word)] span = (span[0], span[1] - len(word)) found = True if not surface: return None, None split = surface.lower().split() if split[0] in ['one', 'a', 'an'] and len(split) > 1 and split[1] in \ r.UNITS + r.TENS: span = (span[0] + len(surface.split()[0]) + 1, span[1]) surface = ' '.join(surface.split()[1:]) return surface, span
Remove spurious characters from a quantity's surface.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L20-L49
marcolagi/quantulum
quantulum/parser.py
extract_spellout_values
def extract_spellout_values(text): """Convert spelled out numbers in a given text to digits.""" values = [] for item in r.REG_TXT.finditer(text): surface, span = clean_surface(item.group(0), item.span()) if not surface or surface.lower() in r.SCALES: continue curr = result = 0.0 for word in surface.split(): try: scale, increment = 1, float(word.lower()) except ValueError: scale, increment = r.NUMWORDS[word.lower()] curr = curr * scale + increment if scale > 100: result += curr curr = 0.0 values.append({'old_surface': surface, 'old_span': span, 'new_surface': unicode(result + curr)}) for item in re.finditer(r'\d+(,\d{3})+', text): values.append({'old_surface': item.group(0), 'old_span': item.span(), 'new_surface': unicode(item.group(0).replace(',', ''))}) return sorted(values, key=lambda x: x['old_span'][0])
python
def extract_spellout_values(text): """Convert spelled out numbers in a given text to digits.""" values = [] for item in r.REG_TXT.finditer(text): surface, span = clean_surface(item.group(0), item.span()) if not surface or surface.lower() in r.SCALES: continue curr = result = 0.0 for word in surface.split(): try: scale, increment = 1, float(word.lower()) except ValueError: scale, increment = r.NUMWORDS[word.lower()] curr = curr * scale + increment if scale > 100: result += curr curr = 0.0 values.append({'old_surface': surface, 'old_span': span, 'new_surface': unicode(result + curr)}) for item in re.finditer(r'\d+(,\d{3})+', text): values.append({'old_surface': item.group(0), 'old_span': item.span(), 'new_surface': unicode(item.group(0).replace(',', ''))}) return sorted(values, key=lambda x: x['old_span'][0])
Convert spelled out numbers in a given text to digits.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L53-L79
marcolagi/quantulum
quantulum/parser.py
substitute_values
def substitute_values(text, values): """Convert spelled out numbers in a given text to digits.""" shift, final_text, shifts = 0, text, defaultdict(int) for value in values: first = value['old_span'][0] + shift second = value['old_span'][1] + shift new_s = value['new_surface'] final_text = final_text[0:first] + new_s + final_text[second:] shift += len(new_s) - len(value['old_surface']) for char in range(first + 1, len(final_text)): shifts[char] = shift logging.debug(u'Text after numeric conversion: "%s"', final_text) return final_text, shifts
python
def substitute_values(text, values): """Convert spelled out numbers in a given text to digits.""" shift, final_text, shifts = 0, text, defaultdict(int) for value in values: first = value['old_span'][0] + shift second = value['old_span'][1] + shift new_s = value['new_surface'] final_text = final_text[0:first] + new_s + final_text[second:] shift += len(new_s) - len(value['old_surface']) for char in range(first + 1, len(final_text)): shifts[char] = shift logging.debug(u'Text after numeric conversion: "%s"', final_text) return final_text, shifts
Convert spelled out numbers in a given text to digits.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L83-L97
marcolagi/quantulum
quantulum/parser.py
get_values
def get_values(item): """Extract value from regex hit.""" fracs = r'|'.join(r.UNI_FRAC) value = item.group(2) value = re.sub(ur'(?<=\d)(%s)10' % r.MULTIPLIERS, 'e', value) value = re.sub(fracs, callback, value, re.IGNORECASE) value = re.sub(' +', ' ', value) range_separator = re.findall(ur'\d+ ?(-|and|(?:- ?)?to) ?\d', value) uncer_separator = re.findall(ur'\d+ ?(\+/-|±) ?\d', value) fract_separator = re.findall(ur'\d+/\d+', value) uncertainty = None if range_separator: values = value.split(range_separator[0]) values = [float(re.sub(r'-$', '', i)) for i in values] elif uncer_separator: values = [float(i) for i in value.split(uncer_separator[0])] uncertainty = values[1] values = [values[0]] elif fract_separator: values = value.split() if len(values) > 1: values = [float(values[0]) + float(Fraction(values[1]))] else: values = [float(Fraction(values[0]))] else: values = [float(re.sub(r'-$', '', value))] logging.debug(u'\tUncertainty: %s', uncertainty) logging.debug(u'\tValues: %s', values) return uncertainty, values
python
def get_values(item): """Extract value from regex hit.""" fracs = r'|'.join(r.UNI_FRAC) value = item.group(2) value = re.sub(ur'(?<=\d)(%s)10' % r.MULTIPLIERS, 'e', value) value = re.sub(fracs, callback, value, re.IGNORECASE) value = re.sub(' +', ' ', value) range_separator = re.findall(ur'\d+ ?(-|and|(?:- ?)?to) ?\d', value) uncer_separator = re.findall(ur'\d+ ?(\+/-|±) ?\d', value) fract_separator = re.findall(ur'\d+/\d+', value) uncertainty = None if range_separator: values = value.split(range_separator[0]) values = [float(re.sub(r'-$', '', i)) for i in values] elif uncer_separator: values = [float(i) for i in value.split(uncer_separator[0])] uncertainty = values[1] values = [values[0]] elif fract_separator: values = value.split() if len(values) > 1: values = [float(values[0]) + float(Fraction(values[1]))] else: values = [float(Fraction(values[0]))] else: values = [float(re.sub(r'-$', '', value))] logging.debug(u'\tUncertainty: %s', uncertainty) logging.debug(u'\tValues: %s', values) return uncertainty, values
Extract value from regex hit.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L107-L140
marcolagi/quantulum
quantulum/parser.py
build_unit_name
def build_unit_name(dimensions): """Build the name of the unit from its dimensions.""" name = '' for unit in dimensions: if unit['power'] < 0: name += 'per ' power = abs(unit['power']) if power == 1: name += unit['base'] elif power == 2: name += 'square ' + unit['base'] elif power == 3: name += 'cubic ' + unit['base'] elif power > 3: name += unit['base'] + ' to the %g' % power name += ' ' name = name.strip() logging.debug(u'\tUnit inferred name: %s', name) return name
python
def build_unit_name(dimensions): """Build the name of the unit from its dimensions.""" name = '' for unit in dimensions: if unit['power'] < 0: name += 'per ' power = abs(unit['power']) if power == 1: name += unit['base'] elif power == 2: name += 'square ' + unit['base'] elif power == 3: name += 'cubic ' + unit['base'] elif power > 3: name += unit['base'] + ' to the %g' % power name += ' ' name = name.strip() logging.debug(u'\tUnit inferred name: %s', name) return name
Build the name of the unit from its dimensions.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L144-L166
marcolagi/quantulum
quantulum/parser.py
get_unit_from_dimensions
def get_unit_from_dimensions(dimensions, text): """Reconcile a unit based on its dimensionality.""" key = l.get_key_from_dimensions(dimensions) try: unit = l.DERIVED_UNI[key] except KeyError: logging.debug(u'\tCould not find unit for: %s', key) unit = c.Unit(name=build_unit_name(dimensions), dimensions=dimensions, entity=get_entity_from_dimensions(dimensions, text)) return unit
python
def get_unit_from_dimensions(dimensions, text): """Reconcile a unit based on its dimensionality.""" key = l.get_key_from_dimensions(dimensions) try: unit = l.DERIVED_UNI[key] except KeyError: logging.debug(u'\tCould not find unit for: %s', key) unit = c.Unit(name=build_unit_name(dimensions), dimensions=dimensions, entity=get_entity_from_dimensions(dimensions, text)) return unit
Reconcile a unit based on its dimensionality.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L170-L182
marcolagi/quantulum
quantulum/parser.py
get_entity_from_dimensions
def get_entity_from_dimensions(dimensions, text): """ Infer the underlying entity of a unit (e.g. "volume" for "m^3"). Just based on the unit's dimensionality if the classifier is disabled. """ new_dimensions = [{'base': l.NAMES[i['base']].entity.name, 'power': i['power']} for i in dimensions] final_dimensions = sorted(new_dimensions, key=lambda x: x['base']) key = l.get_key_from_dimensions(final_dimensions) try: if clf.USE_CLF: ent = clf.disambiguate_entity(key, text) else: ent = l.DERIVED_ENT[key][0] except IndexError: logging.debug(u'\tCould not find entity for: %s', key) ent = c.Entity(name='unknown', dimensions=new_dimensions) return ent
python
def get_entity_from_dimensions(dimensions, text): """ Infer the underlying entity of a unit (e.g. "volume" for "m^3"). Just based on the unit's dimensionality if the classifier is disabled. """ new_dimensions = [{'base': l.NAMES[i['base']].entity.name, 'power': i['power']} for i in dimensions] final_dimensions = sorted(new_dimensions, key=lambda x: x['base']) key = l.get_key_from_dimensions(final_dimensions) try: if clf.USE_CLF: ent = clf.disambiguate_entity(key, text) else: ent = l.DERIVED_ENT[key][0] except IndexError: logging.debug(u'\tCould not find entity for: %s', key) ent = c.Entity(name='unknown', dimensions=new_dimensions) return ent
Infer the underlying entity of a unit (e.g. "volume" for "m^3"). Just based on the unit's dimensionality if the classifier is disabled.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L186-L207
marcolagi/quantulum
quantulum/parser.py
parse_unit
def parse_unit(item, group, slash): """Parse surface and power from unit text.""" surface = item.group(group).replace('.', '') power = re.findall(r'\-?[0-9%s]+' % r.SUPERSCRIPTS, surface) if power: power = [r.UNI_SUPER[i] if i in r.UNI_SUPER else i for i in power] power = ''.join(power) new_power = (-1 * int(power) if slash else int(power)) surface = re.sub(r'\^?\-?[0-9%s]+' % r.SUPERSCRIPTS, '', surface) elif re.findall(r'\bcubed\b', surface): new_power = (-3 if slash else 3) surface = re.sub(r'\bcubed\b', '', surface).strip() elif re.findall(r'\bsquared\b', surface): new_power = (-2 if slash else 2) surface = re.sub(r'\bsquared\b', '', surface).strip() else: new_power = (-1 if slash else 1) return surface, new_power
python
def parse_unit(item, group, slash): """Parse surface and power from unit text.""" surface = item.group(group).replace('.', '') power = re.findall(r'\-?[0-9%s]+' % r.SUPERSCRIPTS, surface) if power: power = [r.UNI_SUPER[i] if i in r.UNI_SUPER else i for i in power] power = ''.join(power) new_power = (-1 * int(power) if slash else int(power)) surface = re.sub(r'\^?\-?[0-9%s]+' % r.SUPERSCRIPTS, '', surface) elif re.findall(r'\bcubed\b', surface): new_power = (-3 if slash else 3) surface = re.sub(r'\bcubed\b', '', surface).strip() elif re.findall(r'\bsquared\b', surface): new_power = (-2 if slash else 2) surface = re.sub(r'\bsquared\b', '', surface).strip() else: new_power = (-1 if slash else 1) return surface, new_power
Parse surface and power from unit text.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L211-L234
marcolagi/quantulum
quantulum/parser.py
get_unit
def get_unit(item, text): """Extract unit from regex hit.""" group_units = [1, 4, 6, 8, 10] group_operators = [3, 5, 7, 9] item_units = [item.group(i) for i in group_units if item.group(i)] if len(item_units) == 0: unit = l.NAMES['dimensionless'] else: dimensions, slash = [], False for group in sorted(group_units + group_operators): if not item.group(group): continue if group in group_units: surface, power = parse_unit(item, group, slash) if clf.USE_CLF: base = clf.disambiguate_unit(surface, text).name else: base = l.UNITS[surface][0].name dimensions += [{'base': base, 'power': power}] elif not slash: slash = any(i in item.group(group) for i in [u'/', u' per ']) unit = get_unit_from_dimensions(dimensions, text) logging.debug(u'\tUnit: %s', unit) logging.debug(u'\tEntity: %s', unit.entity) return unit
python
def get_unit(item, text): """Extract unit from regex hit.""" group_units = [1, 4, 6, 8, 10] group_operators = [3, 5, 7, 9] item_units = [item.group(i) for i in group_units if item.group(i)] if len(item_units) == 0: unit = l.NAMES['dimensionless'] else: dimensions, slash = [], False for group in sorted(group_units + group_operators): if not item.group(group): continue if group in group_units: surface, power = parse_unit(item, group, slash) if clf.USE_CLF: base = clf.disambiguate_unit(surface, text).name else: base = l.UNITS[surface][0].name dimensions += [{'base': base, 'power': power}] elif not slash: slash = any(i in item.group(group) for i in [u'/', u' per ']) unit = get_unit_from_dimensions(dimensions, text) logging.debug(u'\tUnit: %s', unit) logging.debug(u'\tEntity: %s', unit.entity) return unit
Extract unit from regex hit.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L238-L267
marcolagi/quantulum
quantulum/parser.py
get_surface
def get_surface(shifts, orig_text, item, text): """Extract surface from regex hit.""" span = item.span() logging.debug(u'\tInitial span: %s ("%s")', span, text[span[0]:span[1]]) real_span = (span[0] - shifts[span[0]], span[1] - shifts[span[1] - 1]) surface = orig_text[real_span[0]:real_span[1]] logging.debug(u'\tShifted span: %s ("%s")', real_span, surface) while any(surface.endswith(i) for i in [' ', '-']): surface = surface[:-1] real_span = (real_span[0], real_span[1] - 1) while surface.startswith(' '): surface = surface[1:] real_span = (real_span[0] + 1, real_span[1]) logging.debug(u'\tFinal span: %s ("%s")', real_span, surface) return surface, real_span
python
def get_surface(shifts, orig_text, item, text): """Extract surface from regex hit.""" span = item.span() logging.debug(u'\tInitial span: %s ("%s")', span, text[span[0]:span[1]]) real_span = (span[0] - shifts[span[0]], span[1] - shifts[span[1] - 1]) surface = orig_text[real_span[0]:real_span[1]] logging.debug(u'\tShifted span: %s ("%s")', real_span, surface) while any(surface.endswith(i) for i in [' ', '-']): surface = surface[:-1] real_span = (real_span[0], real_span[1] - 1) while surface.startswith(' '): surface = surface[1:] real_span = (real_span[0] + 1, real_span[1]) logging.debug(u'\tFinal span: %s ("%s")', real_span, surface) return surface, real_span
Extract surface from regex hit.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L271-L289
marcolagi/quantulum
quantulum/parser.py
is_quote_artifact
def is_quote_artifact(orig_text, span): """Distinguish between quotes and units.""" res = False cursor = re.finditer(r'("|\')[^ .,:;?!()*+-].*?("|\')', orig_text) for item in cursor: if item.span()[1] == span[1]: res = True return res
python
def is_quote_artifact(orig_text, span): """Distinguish between quotes and units.""" res = False cursor = re.finditer(r'("|\')[^ .,:;?!()*+-].*?("|\')', orig_text) for item in cursor: if item.span()[1] == span[1]: res = True return res
Distinguish between quotes and units.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L293-L302
marcolagi/quantulum
quantulum/parser.py
build_quantity
def build_quantity(orig_text, text, item, values, unit, surface, span, uncert): """Build a Quantity object out of extracted information.""" # Discard irrelevant txt2float extractions, cardinal numbers, codes etc. if surface.lower() in ['a', 'an', 'one'] or \ re.search(r'1st|2nd|3rd|[04-9]th', surface) or \ re.search(r'\d+[A-Z]+\d+', surface) or \ re.search(r'\ba second\b', surface, re.IGNORECASE): logging.debug(u'\tMeaningless quantity ("%s"), discard', surface) return # Usually "$3T" does not stand for "dollar tesla" elif unit.entity.dimensions and \ unit.entity.dimensions[0]['base'] == 'currency': if len(unit.dimensions) > 1: try: suffix = re.findall(r'\d(K|M|B|T)\b(.*?)$', surface)[0] values = [i * r.SUFFIXES[suffix[0]] for i in values] unit = l.UNITS[unit.dimensions[0]['base']][0] if suffix[1]: surface = surface[:surface.find(suffix[1])] span = (span[0], span[1] - len(suffix[1])) logging.debug(u'\tCorrect for "$3T" pattern') except IndexError: pass else: try: suffix = re.findall(r'%s(K|M|B|T)\b' % re.escape(surface), orig_text)[0] surface += suffix span = (span[0], span[1] + 1) values = [i * r.SUFFIXES[suffix] for i in values] logging.debug(u'\tCorrect for "$3T" pattern') except IndexError: pass # Usually "1990s" stands for the decade, not the amount of seconds elif re.match(r'[1-2]\d\d0s', surface): unit = l.NAMES['dimensionless'] surface = surface[:-1] span = (span[0], span[1] - 1) logging.debug(u'\tCorrect for decade pattern') # Usually "in" stands for the preposition, not inches elif unit.dimensions[-1]['base'] == 'inch' and \ re.search(r' in$', surface) and '/' not in surface: if len(unit.dimensions) > 1: unit = get_unit_from_dimensions(unit.dimensions[:-1], orig_text) else: unit = l.NAMES['dimensionless'] surface = surface[:-3] span = (span[0], span[1] - 3) logging.debug(u'\tCorrect for "in" pattern') elif is_quote_artifact(text, item.span()): if len(unit.dimensions) > 1: unit = get_unit_from_dimensions(unit.dimensions[:-1], orig_text) else: unit = l.NAMES['dimensionless'] surface = surface[:-1] span = (span[0], span[1] - 1) logging.debug(u'\tCorrect for quotes') elif re.search(r' time$', surface) and len(unit.dimensions) > 1 and \ unit.dimensions[-1]['base'] == 'count': unit = get_unit_from_dimensions(unit.dimensions[:-1], orig_text) surface = surface[:-5] span = (span[0], span[1] - 5) logging.debug(u'\tCorrect for "time"') objs = [] for value in values: obj = c.Quantity(value=value, unit=unit, surface=surface, span=span, uncertainty=uncert) objs.append(obj) return objs
python
def build_quantity(orig_text, text, item, values, unit, surface, span, uncert): """Build a Quantity object out of extracted information.""" # Discard irrelevant txt2float extractions, cardinal numbers, codes etc. if surface.lower() in ['a', 'an', 'one'] or \ re.search(r'1st|2nd|3rd|[04-9]th', surface) or \ re.search(r'\d+[A-Z]+\d+', surface) or \ re.search(r'\ba second\b', surface, re.IGNORECASE): logging.debug(u'\tMeaningless quantity ("%s"), discard', surface) return # Usually "$3T" does not stand for "dollar tesla" elif unit.entity.dimensions and \ unit.entity.dimensions[0]['base'] == 'currency': if len(unit.dimensions) > 1: try: suffix = re.findall(r'\d(K|M|B|T)\b(.*?)$', surface)[0] values = [i * r.SUFFIXES[suffix[0]] for i in values] unit = l.UNITS[unit.dimensions[0]['base']][0] if suffix[1]: surface = surface[:surface.find(suffix[1])] span = (span[0], span[1] - len(suffix[1])) logging.debug(u'\tCorrect for "$3T" pattern') except IndexError: pass else: try: suffix = re.findall(r'%s(K|M|B|T)\b' % re.escape(surface), orig_text)[0] surface += suffix span = (span[0], span[1] + 1) values = [i * r.SUFFIXES[suffix] for i in values] logging.debug(u'\tCorrect for "$3T" pattern') except IndexError: pass # Usually "1990s" stands for the decade, not the amount of seconds elif re.match(r'[1-2]\d\d0s', surface): unit = l.NAMES['dimensionless'] surface = surface[:-1] span = (span[0], span[1] - 1) logging.debug(u'\tCorrect for decade pattern') # Usually "in" stands for the preposition, not inches elif unit.dimensions[-1]['base'] == 'inch' and \ re.search(r' in$', surface) and '/' not in surface: if len(unit.dimensions) > 1: unit = get_unit_from_dimensions(unit.dimensions[:-1], orig_text) else: unit = l.NAMES['dimensionless'] surface = surface[:-3] span = (span[0], span[1] - 3) logging.debug(u'\tCorrect for "in" pattern') elif is_quote_artifact(text, item.span()): if len(unit.dimensions) > 1: unit = get_unit_from_dimensions(unit.dimensions[:-1], orig_text) else: unit = l.NAMES['dimensionless'] surface = surface[:-1] span = (span[0], span[1] - 1) logging.debug(u'\tCorrect for quotes') elif re.search(r' time$', surface) and len(unit.dimensions) > 1 and \ unit.dimensions[-1]['base'] == 'count': unit = get_unit_from_dimensions(unit.dimensions[:-1], orig_text) surface = surface[:-5] span = (span[0], span[1] - 5) logging.debug(u'\tCorrect for "time"') objs = [] for value in values: obj = c.Quantity(value=value, unit=unit, surface=surface, span=span, uncertainty=uncert) objs.append(obj) return objs
Build a Quantity object out of extracted information.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L306-L384
marcolagi/quantulum
quantulum/parser.py
clean_text
def clean_text(text): """Clean text before parsing.""" # Replace a few nasty unicode characters with their ASCII equivalent maps = {u'×': u'x', u'–': u'-', u'−': '-'} for element in maps: text = text.replace(element, maps[element]) # Replace genitives text = re.sub(r'(?<=\w)\'s\b|(?<=\w)s\'(?!\w)', ' ', text) logging.debug(u'Clean text: "%s"', text) return text
python
def clean_text(text): """Clean text before parsing.""" # Replace a few nasty unicode characters with their ASCII equivalent maps = {u'×': u'x', u'–': u'-', u'−': '-'} for element in maps: text = text.replace(element, maps[element]) # Replace genitives text = re.sub(r'(?<=\w)\'s\b|(?<=\w)s\'(?!\w)', ' ', text) logging.debug(u'Clean text: "%s"', text) return text
Clean text before parsing.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L388-L400
marcolagi/quantulum
quantulum/parser.py
parse
def parse(text, verbose=False): """Extract all quantities from unstructured text.""" log_format = ('%(asctime)s --- %(message)s') logging.basicConfig(format=log_format) root = logging.getLogger() if verbose: level = root.level root.setLevel(logging.DEBUG) logging.debug(u'Verbose mode') if isinstance(text, str): text = text.decode('utf-8') logging.debug(u'Converted string to unicode (assume utf-8 encoding)') orig_text = text logging.debug(u'Original text: "%s"', orig_text) text = clean_text(text) values = extract_spellout_values(text) text, shifts = substitute_values(text, values) quantities = [] for item in r.REG_DIM.finditer(text): groups = dict([i for i in item.groupdict().items() if i[1] and i[1].strip()]) logging.debug(u'Quantity found: %s', groups) try: uncert, values = get_values(item) except ValueError as err: logging.debug(u'Could not parse quantity: %s', err) unit = get_unit(item, text) surface, span = get_surface(shifts, orig_text, item, text) objs = build_quantity(orig_text, text, item, values, unit, surface, span, uncert) if objs is not None: quantities += objs if verbose: root.level = level return quantities
python
def parse(text, verbose=False): """Extract all quantities from unstructured text.""" log_format = ('%(asctime)s --- %(message)s') logging.basicConfig(format=log_format) root = logging.getLogger() if verbose: level = root.level root.setLevel(logging.DEBUG) logging.debug(u'Verbose mode') if isinstance(text, str): text = text.decode('utf-8') logging.debug(u'Converted string to unicode (assume utf-8 encoding)') orig_text = text logging.debug(u'Original text: "%s"', orig_text) text = clean_text(text) values = extract_spellout_values(text) text, shifts = substitute_values(text, values) quantities = [] for item in r.REG_DIM.finditer(text): groups = dict([i for i in item.groupdict().items() if i[1] and i[1].strip()]) logging.debug(u'Quantity found: %s', groups) try: uncert, values = get_values(item) except ValueError as err: logging.debug(u'Could not parse quantity: %s', err) unit = get_unit(item, text) surface, span = get_surface(shifts, orig_text, item, text) objs = build_quantity(orig_text, text, item, values, unit, surface, span, uncert) if objs is not None: quantities += objs if verbose: root.level = level return quantities
Extract all quantities from unstructured text.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L404-L448
marcolagi/quantulum
quantulum/parser.py
inline_parse
def inline_parse(text, verbose=False): """Extract all quantities from unstructured text.""" if isinstance(text, str): text = text.decode('utf-8') parsed = parse(text, verbose=verbose) shift = 0 for quantity in parsed: index = quantity.span[1] + shift to_add = u' {' + unicode(quantity) + u'}' text = text[0:index] + to_add + text[index:] shift += len(to_add) return text
python
def inline_parse(text, verbose=False): """Extract all quantities from unstructured text.""" if isinstance(text, str): text = text.decode('utf-8') parsed = parse(text, verbose=verbose) shift = 0 for quantity in parsed: index = quantity.span[1] + shift to_add = u' {' + unicode(quantity) + u'}' text = text[0:index] + to_add + text[index:] shift += len(to_add) return text
Extract all quantities from unstructured text.
https://github.com/marcolagi/quantulum/blob/28b697dfa997116c1aa3ef63a3ceb8725bffd24f/quantulum/parser.py#L452-L466
hharnisc/python-meteor
MeteorClient.py
MeteorClient._reconnected
def _reconnected(self): """Reconnect Currently we get a new session every time so we have to clear all the data an resubscribe""" if self._login_data or self._login_token: def reconnect_login_callback(error, result): if error: if self._login_token: self._login_token = None self._login(self._login_data, callback=reconnect_login_callback) return else: raise MeteorClientException( 'Failed to re-authenticate during reconnect') self.connected = True self._resubscribe() if self._login_token: self._resume(self._login_token, callback=reconnect_login_callback) else: self._login(self._login_data, callback=reconnect_login_callback) else: self._resubscribe()
python
def _reconnected(self): """Reconnect Currently we get a new session every time so we have to clear all the data an resubscribe""" if self._login_data or self._login_token: def reconnect_login_callback(error, result): if error: if self._login_token: self._login_token = None self._login(self._login_data, callback=reconnect_login_callback) return else: raise MeteorClientException( 'Failed to re-authenticate during reconnect') self.connected = True self._resubscribe() if self._login_token: self._resume(self._login_token, callback=reconnect_login_callback) else: self._login(self._login_data, callback=reconnect_login_callback) else: self._resubscribe()
Reconnect Currently we get a new session every time so we have to clear all the data an resubscribe
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L61-L90
hharnisc/python-meteor
MeteorClient.py
MeteorClient.login
def login(self, user, password, token=None, callback=None): """Login with a username and password Arguments: user - username or email address password - the password for the account Keyword Arguments: token - meteor resume token callback - callback function containing error as first argument and login data""" # TODO: keep the tokenExpires around so we know the next time # we need to authenticate # hash the password hashed = hashlib.sha256(password).hexdigest() # handle username or email address if '@' in user: user_object = { 'email': user } else: user_object = { 'username': user } password_object = { 'algorithm': 'sha-256', 'digest': hashed } self._login_token = token self._login_data = {'user': user_object, 'password': password_object} if token: self._resume(token, callback=callback) else: self._login(self._login_data, callback=callback)
python
def login(self, user, password, token=None, callback=None): """Login with a username and password Arguments: user - username or email address password - the password for the account Keyword Arguments: token - meteor resume token callback - callback function containing error as first argument and login data""" # TODO: keep the tokenExpires around so we know the next time # we need to authenticate # hash the password hashed = hashlib.sha256(password).hexdigest() # handle username or email address if '@' in user: user_object = { 'email': user } else: user_object = { 'username': user } password_object = { 'algorithm': 'sha-256', 'digest': hashed } self._login_token = token self._login_data = {'user': user_object, 'password': password_object} if token: self._resume(token, callback=callback) else: self._login(self._login_data, callback=callback)
Login with a username and password Arguments: user - username or email address password - the password for the account Keyword Arguments: token - meteor resume token callback - callback function containing error as first argument and login data
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L103-L138
hharnisc/python-meteor
MeteorClient.py
MeteorClient.logout
def logout(self, callback=None): """Logout a user Keyword Arguments: callback - callback function called when the user has been logged out""" self.ddp_client.call('logout', [], callback=callback) self.emit('logged_out')
python
def logout(self, callback=None): """Logout a user Keyword Arguments: callback - callback function called when the user has been logged out""" self.ddp_client.call('logout', [], callback=callback) self.emit('logged_out')
Logout a user Keyword Arguments: callback - callback function called when the user has been logged out
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L165-L171
hharnisc/python-meteor
MeteorClient.py
MeteorClient.call
def call(self, method, params, callback=None): """Call a remote method Arguments: method - remote method name params - remote method parameters Keyword Arguments: callback - callback function containing return data""" self._wait_for_connect() self.ddp_client.call(method, params, callback=callback)
python
def call(self, method, params, callback=None): """Call a remote method Arguments: method - remote method name params - remote method parameters Keyword Arguments: callback - callback function containing return data""" self._wait_for_connect() self.ddp_client.call(method, params, callback=callback)
Call a remote method Arguments: method - remote method name params - remote method parameters Keyword Arguments: callback - callback function containing return data
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L177-L187
hharnisc/python-meteor
MeteorClient.py
MeteorClient.subscribe
def subscribe(self, name, params=[], callback=None): """Subscribe to a collection Arguments: name - the name of the publication params - the subscription parameters Keyword Arguments: callback - a function callback that returns an error (if exists)""" self._wait_for_connect() def subscribed(error, sub_id): if error: self._remove_sub_by_id(sub_id) if callback: callback(error.get('reason')) return if callback: callback(None) self.emit('subscribed', name) if name in self.subscriptions: raise MeteorClientException('Already subcribed to {}'.format(name)) sub_id = self.ddp_client.subscribe(name, params, subscribed) self.subscriptions[name] = { 'id': sub_id, 'params': params }
python
def subscribe(self, name, params=[], callback=None): """Subscribe to a collection Arguments: name - the name of the publication params - the subscription parameters Keyword Arguments: callback - a function callback that returns an error (if exists)""" self._wait_for_connect() def subscribed(error, sub_id): if error: self._remove_sub_by_id(sub_id) if callback: callback(error.get('reason')) return if callback: callback(None) self.emit('subscribed', name) if name in self.subscriptions: raise MeteorClientException('Already subcribed to {}'.format(name)) sub_id = self.ddp_client.subscribe(name, params, subscribed) self.subscriptions[name] = { 'id': sub_id, 'params': params }
Subscribe to a collection Arguments: name - the name of the publication params - the subscription parameters Keyword Arguments: callback - a function callback that returns an error (if exists)
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L193-L220
hharnisc/python-meteor
MeteorClient.py
MeteorClient.unsubscribe
def unsubscribe(self, name): """Unsubscribe from a collection Arguments: name - the name of the publication""" self._wait_for_connect() if name not in self.subscriptions: raise MeteorClientException('No subscription for {}'.format(name)) self.ddp_client.unsubscribe(self.subscriptions[name]['id']) del self.subscriptions[name] self.emit('unsubscribed', name)
python
def unsubscribe(self, name): """Unsubscribe from a collection Arguments: name - the name of the publication""" self._wait_for_connect() if name not in self.subscriptions: raise MeteorClientException('No subscription for {}'.format(name)) self.ddp_client.unsubscribe(self.subscriptions[name]['id']) del self.subscriptions[name] self.emit('unsubscribed', name)
Unsubscribe from a collection Arguments: name - the name of the publication
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L222-L232
hharnisc/python-meteor
MeteorClient.py
MeteorClient.find
def find(self, collection, selector={}): """Find data in a collection Arguments: collection - collection to search Keyword Arguments: selector - the query (default returns all items in a collection)""" results = [] for _id, doc in self.collection_data.data.get(collection, {}).items(): doc.update({'_id': _id}) if selector == {}: results.append(doc) for key, value in selector.items(): if key in doc and doc[key] == value: results.append(doc) return results
python
def find(self, collection, selector={}): """Find data in a collection Arguments: collection - collection to search Keyword Arguments: selector - the query (default returns all items in a collection)""" results = [] for _id, doc in self.collection_data.data.get(collection, {}).items(): doc.update({'_id': _id}) if selector == {}: results.append(doc) for key, value in selector.items(): if key in doc and doc[key] == value: results.append(doc) return results
Find data in a collection Arguments: collection - collection to search Keyword Arguments: selector - the query (default returns all items in a collection)
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L238-L254
hharnisc/python-meteor
MeteorClient.py
MeteorClient.find_one
def find_one(self, collection, selector={}): """Return one item from a collection Arguments: collection - collection to search Keyword Arguments: selector - the query (default returns first item found)""" for _id, doc in self.collection_data.data.get(collection, {}).items(): doc.update({'_id': _id}) if selector == {}: return doc for key, value in selector.items(): if key in doc and doc[key] == value: return doc return None
python
def find_one(self, collection, selector={}): """Return one item from a collection Arguments: collection - collection to search Keyword Arguments: selector - the query (default returns first item found)""" for _id, doc in self.collection_data.data.get(collection, {}).items(): doc.update({'_id': _id}) if selector == {}: return doc for key, value in selector.items(): if key in doc and doc[key] == value: return doc return None
Return one item from a collection Arguments: collection - collection to search Keyword Arguments: selector - the query (default returns first item found)
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L256-L271
hharnisc/python-meteor
MeteorClient.py
MeteorClient.insert
def insert(self, collection, doc, callback=None): """Insert an item into a collection Arguments: collection - the collection to be modified doc - The document to insert. May not yet have an _id attribute, in which case Meteor will generate one for you. Keyword Arguments: callback - Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.""" self.call("/" + collection + "/insert", [doc], callback=callback)
python
def insert(self, collection, doc, callback=None): """Insert an item into a collection Arguments: collection - the collection to be modified doc - The document to insert. May not yet have an _id attribute, in which case Meteor will generate one for you. Keyword Arguments: callback - Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.""" self.call("/" + collection + "/insert", [doc], callback=callback)
Insert an item into a collection Arguments: collection - the collection to be modified doc - The document to insert. May not yet have an _id attribute, in which case Meteor will generate one for you. Keyword Arguments: callback - Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L273-L284
hharnisc/python-meteor
MeteorClient.py
MeteorClient.update
def update(self, collection, selector, modifier, callback=None): """Insert an item into a collection Arguments: collection - the collection to be modified selector - specifies which documents to modify modifier - Specifies how to modify the documents Keyword Arguments: callback - Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.""" self.call("/" + collection + "/update", [selector, modifier], callback=callback)
python
def update(self, collection, selector, modifier, callback=None): """Insert an item into a collection Arguments: collection - the collection to be modified selector - specifies which documents to modify modifier - Specifies how to modify the documents Keyword Arguments: callback - Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.""" self.call("/" + collection + "/update", [selector, modifier], callback=callback)
Insert an item into a collection Arguments: collection - the collection to be modified selector - specifies which documents to modify modifier - Specifies how to modify the documents Keyword Arguments: callback - Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L286-L297
hharnisc/python-meteor
MeteorClient.py
MeteorClient.remove
def remove(self, collection, selector, callback=None): """Remove an item from a collection Arguments: collection - the collection to be modified selector - Specifies which documents to remove Keyword Arguments: callback - Optional. If present, called with an error object as its argument.""" self.call("/" + collection + "/remove", [selector], callback=callback)
python
def remove(self, collection, selector, callback=None): """Remove an item from a collection Arguments: collection - the collection to be modified selector - Specifies which documents to remove Keyword Arguments: callback - Optional. If present, called with an error object as its argument.""" self.call("/" + collection + "/remove", [selector], callback=callback)
Remove an item from a collection Arguments: collection - the collection to be modified selector - Specifies which documents to remove Keyword Arguments: callback - Optional. If present, called with an error object as its argument.
https://github.com/hharnisc/python-meteor/blob/b3ad728660785d5506bba6948436d061ee8ca5bc/MeteorClient.py#L299-L308
pikhovkin/simple-websocket-server
simple_websocket_server/__init__.py
WebSocket.close
def close(self, status=1000, reason=u''): """ Send Close frame to the client. The underlying socket is only closed when the client acknowledges the Close frame. status is the closing identifier. reason is the reason for the close. """ try: if self.closed is False: close_msg = bytearray() close_msg.extend(struct.pack("!H", status)) if _check_unicode(reason): close_msg.extend(reason.encode('utf-8')) else: close_msg.extend(reason) self._send_message(False, CLOSE, close_msg) finally: self.closed = True
python
def close(self, status=1000, reason=u''): """ Send Close frame to the client. The underlying socket is only closed when the client acknowledges the Close frame. status is the closing identifier. reason is the reason for the close. """ try: if self.closed is False: close_msg = bytearray() close_msg.extend(struct.pack("!H", status)) if _check_unicode(reason): close_msg.extend(reason.encode('utf-8')) else: close_msg.extend(reason) self._send_message(False, CLOSE, close_msg) finally: self.closed = True
Send Close frame to the client. The underlying socket is only closed when the client acknowledges the Close frame. status is the closing identifier. reason is the reason for the close.
https://github.com/pikhovkin/simple-websocket-server/blob/0f77db8d43f089c8b6a602df8b013b54d73cc367/simple_websocket_server/__init__.py#L277-L296
pikhovkin/simple-websocket-server
simple_websocket_server/__init__.py
WebSocket.send_fragment_start
def send_fragment_start(self, data): """ Send the start of a data fragment stream to a websocket client. Subsequent data should be sent using sendFragment(). A fragment stream is completed when sendFragmentEnd() is called. If data is a unicode object then the frame is sent as Text. If the data is a bytearray object then the frame is sent as Binary. """ opcode = BINARY if _check_unicode(data): opcode = TEXT self._send_message(True, opcode, data)
python
def send_fragment_start(self, data): """ Send the start of a data fragment stream to a websocket client. Subsequent data should be sent using sendFragment(). A fragment stream is completed when sendFragmentEnd() is called. If data is a unicode object then the frame is sent as Text. If the data is a bytearray object then the frame is sent as Binary. """ opcode = BINARY if _check_unicode(data): opcode = TEXT self._send_message(True, opcode, data)
Send the start of a data fragment stream to a websocket client. Subsequent data should be sent using sendFragment(). A fragment stream is completed when sendFragmentEnd() is called. If data is a unicode object then the frame is sent as Text. If the data is a bytearray object then the frame is sent as Binary.
https://github.com/pikhovkin/simple-websocket-server/blob/0f77db8d43f089c8b6a602df8b013b54d73cc367/simple_websocket_server/__init__.py#L324-L337
pikhovkin/simple-websocket-server
simple_websocket_server/__init__.py
WebSocket.send_message
def send_message(self, data): """ Send websocket data frame to the client. If data is a unicode object then the frame is sent as Text. If the data is a bytearray object then the frame is sent as Binary. """ opcode = BINARY if _check_unicode(data): opcode = TEXT self._send_message(False, opcode, data)
python
def send_message(self, data): """ Send websocket data frame to the client. If data is a unicode object then the frame is sent as Text. If the data is a bytearray object then the frame is sent as Binary. """ opcode = BINARY if _check_unicode(data): opcode = TEXT self._send_message(False, opcode, data)
Send websocket data frame to the client. If data is a unicode object then the frame is sent as Text. If the data is a bytearray object then the frame is sent as Binary.
https://github.com/pikhovkin/simple-websocket-server/blob/0f77db8d43f089c8b6a602df8b013b54d73cc367/simple_websocket_server/__init__.py#L357-L368
dougn/python-plantuml
plantuml.py
deflate_and_encode
def deflate_and_encode(plantuml_text): """zlib compress the plantuml text and encode it for the plantuml server. """ zlibbed_str = zlib.compress(plantuml_text.encode('utf-8')) compressed_string = zlibbed_str[2:-4] return encode(compressed_string.decode('latin-1'))
python
def deflate_and_encode(plantuml_text): """zlib compress the plantuml text and encode it for the plantuml server. """ zlibbed_str = zlib.compress(plantuml_text.encode('utf-8')) compressed_string = zlibbed_str[2:-4] return encode(compressed_string.decode('latin-1'))
zlib compress the plantuml text and encode it for the plantuml server.
https://github.com/dougn/python-plantuml/blob/f81c51ee73f3ebad9040a2911af0519d1a835811/plantuml.py#L43-L48
dougn/python-plantuml
plantuml.py
encode
def encode(data): """encode the plantuml data which may be compresses in the proper encoding for the plantuml server """ res = "" for i in range(0,len(data), 3): if (i+2==len(data)): res += _encode3bytes(ord(data[i]), ord(data[i+1]), 0) elif (i+1==len(data)): res += _encode3bytes(ord(data[i]), 0, 0) else: res += _encode3bytes(ord(data[i]), ord(data[i+1]), ord(data[i+2])) return res
python
def encode(data): """encode the plantuml data which may be compresses in the proper encoding for the plantuml server """ res = "" for i in range(0,len(data), 3): if (i+2==len(data)): res += _encode3bytes(ord(data[i]), ord(data[i+1]), 0) elif (i+1==len(data)): res += _encode3bytes(ord(data[i]), 0, 0) else: res += _encode3bytes(ord(data[i]), ord(data[i+1]), ord(data[i+2])) return res
encode the plantuml data which may be compresses in the proper encoding for the plantuml server
https://github.com/dougn/python-plantuml/blob/f81c51ee73f3ebad9040a2911af0519d1a835811/plantuml.py#L50-L62
dougn/python-plantuml
plantuml.py
PlantUML.processes
def processes(self, plantuml_text): """Processes the plantuml text into the raw PNG image data. :param str plantuml_text: The plantuml markup to render :returns: the raw image data """ url = self.get_url(plantuml_text) try: response, content = self.http.request(url, **self.request_opts) except self.HttpLib2Error as e: raise PlantUMLConnectionError(e) if response.status != 200: raise PlantUMLHTTPError(response, content) return content
python
def processes(self, plantuml_text): """Processes the plantuml text into the raw PNG image data. :param str plantuml_text: The plantuml markup to render :returns: the raw image data """ url = self.get_url(plantuml_text) try: response, content = self.http.request(url, **self.request_opts) except self.HttpLib2Error as e: raise PlantUMLConnectionError(e) if response.status != 200: raise PlantUMLHTTPError(response, content) return content
Processes the plantuml text into the raw PNG image data. :param str plantuml_text: The plantuml markup to render :returns: the raw image data
https://github.com/dougn/python-plantuml/blob/f81c51ee73f3ebad9040a2911af0519d1a835811/plantuml.py#L171-L184
dougn/python-plantuml
plantuml.py
PlantUML.processes_file
def processes_file(self, filename, outfile=None, errorfile=None): """Take a filename of a file containing plantuml text and processes it into a .png image. :param str filename: Text file containing plantuml markup :param str outfile: Filename to write the output image to. If not supplied, then it will be the input filename with the file extension replaced with '.png'. :param str errorfile: Filename to write server html error page to. If this is not supplined, then it will be the input ``filename`` with the extension replaced with '_error.html'. :returns: ``True`` if the image write succedded, ``False`` if there was an error written to ``errorfile``. """ if outfile is None: outfile = os.path.splitext(filename)[0] + '.png' if errorfile is None: errorfile = os.path.splitext(filename)[0] + '_error.html' data = open(filename, 'U').read() try: content = self.processes(data) except PlantUMLHTTPError as e: err = open(errorfile, 'w') err.write(e.content) err.close() return False out = open(outfile, 'wb') out.write(content) out.close() return True
python
def processes_file(self, filename, outfile=None, errorfile=None): """Take a filename of a file containing plantuml text and processes it into a .png image. :param str filename: Text file containing plantuml markup :param str outfile: Filename to write the output image to. If not supplied, then it will be the input filename with the file extension replaced with '.png'. :param str errorfile: Filename to write server html error page to. If this is not supplined, then it will be the input ``filename`` with the extension replaced with '_error.html'. :returns: ``True`` if the image write succedded, ``False`` if there was an error written to ``errorfile``. """ if outfile is None: outfile = os.path.splitext(filename)[0] + '.png' if errorfile is None: errorfile = os.path.splitext(filename)[0] + '_error.html' data = open(filename, 'U').read() try: content = self.processes(data) except PlantUMLHTTPError as e: err = open(errorfile, 'w') err.write(e.content) err.close() return False out = open(outfile, 'wb') out.write(content) out.close() return True
Take a filename of a file containing plantuml text and processes it into a .png image. :param str filename: Text file containing plantuml markup :param str outfile: Filename to write the output image to. If not supplied, then it will be the input filename with the file extension replaced with '.png'. :param str errorfile: Filename to write server html error page to. If this is not supplined, then it will be the input ``filename`` with the extension replaced with '_error.html'. :returns: ``True`` if the image write succedded, ``False`` if there was an error written to ``errorfile``.
https://github.com/dougn/python-plantuml/blob/f81c51ee73f3ebad9040a2911af0519d1a835811/plantuml.py#L186-L216
Jellyfish-AI/jf_agent
jf_agent/jira_download.py
download_issuetypes
def download_issuetypes(jira_connection, project_ids): ''' For Jira next-gen projects, issue types can be scoped to projects. For issue types that are scoped to projects, only extract the ones in the extracted projects. ''' print('downloading jira issue types... ', end='', flush=True) result = [] for it in jira_connection.issue_types(): if 'scope' in it.raw and it.raw['scope']['type'] == 'PROJECT': if it.raw['scope']['project']['id'] in project_ids: result.append(it.raw) else: result.append(it.raw) print('✓') return result
python
def download_issuetypes(jira_connection, project_ids): ''' For Jira next-gen projects, issue types can be scoped to projects. For issue types that are scoped to projects, only extract the ones in the extracted projects. ''' print('downloading jira issue types... ', end='', flush=True) result = [] for it in jira_connection.issue_types(): if 'scope' in it.raw and it.raw['scope']['type'] == 'PROJECT': if it.raw['scope']['project']['id'] in project_ids: result.append(it.raw) else: result.append(it.raw) print('✓') return result
For Jira next-gen projects, issue types can be scoped to projects. For issue types that are scoped to projects, only extract the ones in the extracted projects.
https://github.com/Jellyfish-AI/jf_agent/blob/31203a294ad677c8ef9543b45509395537eb1f22/jf_agent/jira_download.py#L58-L73
hynek/pem
src/pem/twisted.py
certificateOptionsFromPEMs
def certificateOptionsFromPEMs(pemObjects, **kw): # type: (List[AbstractPEMObject], **Any) -> ssl.CerticateOptions """ Load a CertificateOptions from the given collection of PEM objects (already-loaded private keys and certificates). In those PEM objects, identify one private key and its corresponding certificate to use as the primary certificate. Then use the rest of the certificates found as chain certificates. Raise a ValueError if no certificate matching a private key is found. :return: A TLS context factory using *pemObjects* :rtype: `twisted.internet.ssl.CertificateOptions`_ .. _`twisted.internet.ssl.CertificateOptions`: \ https://twistedmatrix.com/documents/current/api/\ twisted.internet.ssl.CertificateOptions.html """ keys = [key for key in pemObjects if isinstance(key, Key)] if not len(keys): raise ValueError("Supplied PEM file(s) does *not* contain a key.") if len(keys) > 1: raise ValueError("Supplied PEM file(s) contains *more* than one key.") privateKey = ssl.KeyPair.load(str(keys[0]), FILETYPE_PEM) certs = [cert for cert in pemObjects if isinstance(cert, Certificate)] if not len(certs): raise ValueError("*At least one* certificate is required.") certificates = [ssl.Certificate.loadPEM(str(certPEM)) for certPEM in certs] certificatesByFingerprint = dict( [ (certificate.getPublicKey().keyHash(), certificate) for certificate in certificates ] ) if privateKey.keyHash() not in certificatesByFingerprint: raise ValueError( "No certificate matching {fingerprint} found.".format( fingerprint=privateKey.keyHash() ) ) primaryCertificate = certificatesByFingerprint.pop(privateKey.keyHash()) if "dhParameters" in kw: raise TypeError( "Passing DH parameters as a keyword argument instead of a " "PEM object is not supported anymore." ) dhparams = [o for o in pemObjects if isinstance(o, DHParameters)] if len(dhparams) > 1: raise ValueError( "Supplied PEM file(s) contain(s) *more* than one set of DH " "parameters." ) elif len(dhparams) == 1: kw["dhParameters"] = ssl.DiffieHellmanParameters(str(dhparams[0])) ctxFactory = ssl.CertificateOptions( privateKey=privateKey.original, certificate=primaryCertificate.original, extraCertChain=[ chain.original for chain in certificatesByFingerprint.values() ], **kw ) return ctxFactory
python
def certificateOptionsFromPEMs(pemObjects, **kw): # type: (List[AbstractPEMObject], **Any) -> ssl.CerticateOptions """ Load a CertificateOptions from the given collection of PEM objects (already-loaded private keys and certificates). In those PEM objects, identify one private key and its corresponding certificate to use as the primary certificate. Then use the rest of the certificates found as chain certificates. Raise a ValueError if no certificate matching a private key is found. :return: A TLS context factory using *pemObjects* :rtype: `twisted.internet.ssl.CertificateOptions`_ .. _`twisted.internet.ssl.CertificateOptions`: \ https://twistedmatrix.com/documents/current/api/\ twisted.internet.ssl.CertificateOptions.html """ keys = [key for key in pemObjects if isinstance(key, Key)] if not len(keys): raise ValueError("Supplied PEM file(s) does *not* contain a key.") if len(keys) > 1: raise ValueError("Supplied PEM file(s) contains *more* than one key.") privateKey = ssl.KeyPair.load(str(keys[0]), FILETYPE_PEM) certs = [cert for cert in pemObjects if isinstance(cert, Certificate)] if not len(certs): raise ValueError("*At least one* certificate is required.") certificates = [ssl.Certificate.loadPEM(str(certPEM)) for certPEM in certs] certificatesByFingerprint = dict( [ (certificate.getPublicKey().keyHash(), certificate) for certificate in certificates ] ) if privateKey.keyHash() not in certificatesByFingerprint: raise ValueError( "No certificate matching {fingerprint} found.".format( fingerprint=privateKey.keyHash() ) ) primaryCertificate = certificatesByFingerprint.pop(privateKey.keyHash()) if "dhParameters" in kw: raise TypeError( "Passing DH parameters as a keyword argument instead of a " "PEM object is not supported anymore." ) dhparams = [o for o in pemObjects if isinstance(o, DHParameters)] if len(dhparams) > 1: raise ValueError( "Supplied PEM file(s) contain(s) *more* than one set of DH " "parameters." ) elif len(dhparams) == 1: kw["dhParameters"] = ssl.DiffieHellmanParameters(str(dhparams[0])) ctxFactory = ssl.CertificateOptions( privateKey=privateKey.original, certificate=primaryCertificate.original, extraCertChain=[ chain.original for chain in certificatesByFingerprint.values() ], **kw ) return ctxFactory
Load a CertificateOptions from the given collection of PEM objects (already-loaded private keys and certificates). In those PEM objects, identify one private key and its corresponding certificate to use as the primary certificate. Then use the rest of the certificates found as chain certificates. Raise a ValueError if no certificate matching a private key is found. :return: A TLS context factory using *pemObjects* :rtype: `twisted.internet.ssl.CertificateOptions`_ .. _`twisted.internet.ssl.CertificateOptions`: \ https://twistedmatrix.com/documents/current/api/\ twisted.internet.ssl.CertificateOptions.html
https://github.com/hynek/pem/blob/5a98b0b0012df7211955a72740a9efca02150b04/src/pem/twisted.py#L22-L93
hynek/pem
src/pem/twisted.py
certificateOptionsFromFiles
def certificateOptionsFromFiles(*pemFiles, **kw): # type: (*str, **Any) -> ssl.CertificateOptions """ Read all files named by *pemFiles*, and parse them using :func:`certificateOptionsFromPEMs`. """ pems = [] # type: List[AbstractPEMObject] for pemFile in pemFiles: pems += parse_file(pemFile) return certificateOptionsFromPEMs(pems, **kw)
python
def certificateOptionsFromFiles(*pemFiles, **kw): # type: (*str, **Any) -> ssl.CertificateOptions """ Read all files named by *pemFiles*, and parse them using :func:`certificateOptionsFromPEMs`. """ pems = [] # type: List[AbstractPEMObject] for pemFile in pemFiles: pems += parse_file(pemFile) return certificateOptionsFromPEMs(pems, **kw)
Read all files named by *pemFiles*, and parse them using :func:`certificateOptionsFromPEMs`.
https://github.com/hynek/pem/blob/5a98b0b0012df7211955a72740a9efca02150b04/src/pem/twisted.py#L96-L106
hynek/pem
src/pem/_core.py
parse
def parse(pem_str): # type: (bytes) -> List[AbstractPEMObject] """ Extract PEM objects from *pem_str*. :param pem_str: String to parse. :type pem_str: bytes :return: list of :ref:`pem-objects` """ return [ _PEM_TO_CLASS[match.group(1)](match.group(0)) for match in _PEM_RE.finditer(pem_str) ]
python
def parse(pem_str): # type: (bytes) -> List[AbstractPEMObject] """ Extract PEM objects from *pem_str*. :param pem_str: String to parse. :type pem_str: bytes :return: list of :ref:`pem-objects` """ return [ _PEM_TO_CLASS[match.group(1)](match.group(0)) for match in _PEM_RE.finditer(pem_str) ]
Extract PEM objects from *pem_str*. :param pem_str: String to parse. :type pem_str: bytes :return: list of :ref:`pem-objects`
https://github.com/hynek/pem/blob/5a98b0b0012df7211955a72740a9efca02150b04/src/pem/_core.py#L188-L200
hynek/pem
src/pem/_core.py
AbstractPEMObject.sha1_hexdigest
def sha1_hexdigest(self): # type: () -> str """ A SHA-1 digest of the whole object for easy differentiation. .. versionadded:: 18.1.0 """ if self._sha1_hexdigest is None: self._sha1_hexdigest = hashlib.sha1(self._pem_bytes).hexdigest() return self._sha1_hexdigest
python
def sha1_hexdigest(self): # type: () -> str """ A SHA-1 digest of the whole object for easy differentiation. .. versionadded:: 18.1.0 """ if self._sha1_hexdigest is None: self._sha1_hexdigest = hashlib.sha1(self._pem_bytes).hexdigest() return self._sha1_hexdigest
A SHA-1 digest of the whole object for easy differentiation. .. versionadded:: 18.1.0
https://github.com/hynek/pem/blob/5a98b0b0012df7211955a72740a9efca02150b04/src/pem/_core.py#L50-L60
rytilahti/python-songpal
songpal/containers.py
make
def make(cls, **kwargs): """Create a container. Reports extra keys as well as missing ones. Thanks to habnabit for the idea! """ cls_attrs = {f.name: f for f in attr.fields(cls)} unknown = {k: v for k, v in kwargs.items() if k not in cls_attrs} if len(unknown) > 0: _LOGGER.warning( "Got unknowns for %s: %s - please create an issue!", cls.__name__, unknown ) missing = [k for k in cls_attrs if k not in kwargs] data = {k: v for k, v in kwargs.items() if k in cls_attrs} # initialize missing values to avoid passing default=None # for the attrs attribute definitions for m in missing: default = cls_attrs[m].default if isinstance(default, attr.Factory): if not default.takes_self: data[m] = default.factory() else: raise NotImplementedError else: _LOGGER.debug("Missing key %s with no default for %s", m, cls.__name__) data[m] = None # initialize and store raw data for debug purposes inst = cls(**data) setattr(inst, "raw", kwargs) return inst
python
def make(cls, **kwargs): """Create a container. Reports extra keys as well as missing ones. Thanks to habnabit for the idea! """ cls_attrs = {f.name: f for f in attr.fields(cls)} unknown = {k: v for k, v in kwargs.items() if k not in cls_attrs} if len(unknown) > 0: _LOGGER.warning( "Got unknowns for %s: %s - please create an issue!", cls.__name__, unknown ) missing = [k for k in cls_attrs if k not in kwargs] data = {k: v for k, v in kwargs.items() if k in cls_attrs} # initialize missing values to avoid passing default=None # for the attrs attribute definitions for m in missing: default = cls_attrs[m].default if isinstance(default, attr.Factory): if not default.takes_self: data[m] = default.factory() else: raise NotImplementedError else: _LOGGER.debug("Missing key %s with no default for %s", m, cls.__name__) data[m] = None # initialize and store raw data for debug purposes inst = cls(**data) setattr(inst, "raw", kwargs) return inst
Create a container. Reports extra keys as well as missing ones. Thanks to habnabit for the idea!
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/containers.py#L11-L46
rytilahti/python-songpal
songpal/device.py
Device.create_post_request
async def create_post_request(self, method: str, params: Dict = None): """Call the given method over POST. :param method: Name of the method :param params: dict of parameters :return: JSON object """ if params is None: params = {} headers = {"Content-Type": "application/json"} payload = { "method": method, "params": [params], "id": next(self.idgen), "version": "1.0", } if self.debug > 1: _LOGGER.debug("> POST %s with body: %s", self.guide_endpoint, payload) async with aiohttp.ClientSession(headers=headers) as session: res = await session.post(self.guide_endpoint, json=payload, headers=headers) if self.debug > 1: _LOGGER.debug("Received %s: %s" % (res.status_code, res.text)) if res.status != 200: raise SongpalException( "Got a non-ok (status %s) response for %s" % (res.status, method), error=await res.json()["error"], ) res = await res.json() # TODO handle exceptions from POST? This used to raise SongpalException # on requests.RequestException (Unable to get APIs). if "error" in res: raise SongpalException("Got an error for %s" % method, error=res["error"]) if self.debug > 1: _LOGGER.debug("Got %s: %s", method, pf(res)) return res
python
async def create_post_request(self, method: str, params: Dict = None): """Call the given method over POST. :param method: Name of the method :param params: dict of parameters :return: JSON object """ if params is None: params = {} headers = {"Content-Type": "application/json"} payload = { "method": method, "params": [params], "id": next(self.idgen), "version": "1.0", } if self.debug > 1: _LOGGER.debug("> POST %s with body: %s", self.guide_endpoint, payload) async with aiohttp.ClientSession(headers=headers) as session: res = await session.post(self.guide_endpoint, json=payload, headers=headers) if self.debug > 1: _LOGGER.debug("Received %s: %s" % (res.status_code, res.text)) if res.status != 200: raise SongpalException( "Got a non-ok (status %s) response for %s" % (res.status, method), error=await res.json()["error"], ) res = await res.json() # TODO handle exceptions from POST? This used to raise SongpalException # on requests.RequestException (Unable to get APIs). if "error" in res: raise SongpalException("Got an error for %s" % method, error=res["error"]) if self.debug > 1: _LOGGER.debug("Got %s: %s", method, pf(res)) return res
Call the given method over POST. :param method: Name of the method :param params: dict of parameters :return: JSON object
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L74-L115
rytilahti/python-songpal
songpal/device.py
Device.get_supported_methods
async def get_supported_methods(self): """Get information about supported methods. Calling this as the first thing before doing anything else is necessary to fill the available services table. """ response = await self.request_supported_methods() if "result" in response: services = response["result"][0] _LOGGER.debug("Got %s services!" % len(services)) for x in services: serv = await Service.from_payload( x, self.endpoint, self.idgen, self.debug, self.force_protocol ) if serv is not None: self.services[x["service"]] = serv else: _LOGGER.warning("Unable to create service %s", x["service"]) for service in self.services.values(): if self.debug > 1: _LOGGER.debug("Service %s", service) for api in service.methods: # self.logger.debug("%s > %s" % (service, api)) if self.debug > 1: _LOGGER.debug("> %s" % api) return self.services return None
python
async def get_supported_methods(self): """Get information about supported methods. Calling this as the first thing before doing anything else is necessary to fill the available services table. """ response = await self.request_supported_methods() if "result" in response: services = response["result"][0] _LOGGER.debug("Got %s services!" % len(services)) for x in services: serv = await Service.from_payload( x, self.endpoint, self.idgen, self.debug, self.force_protocol ) if serv is not None: self.services[x["service"]] = serv else: _LOGGER.warning("Unable to create service %s", x["service"]) for service in self.services.values(): if self.debug > 1: _LOGGER.debug("Service %s", service) for api in service.methods: # self.logger.debug("%s > %s" % (service, api)) if self.debug > 1: _LOGGER.debug("> %s" % api) return self.services return None
Get information about supported methods. Calling this as the first thing before doing anything else is necessary to fill the available services table.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L121-L151
rytilahti/python-songpal
songpal/device.py
Device.set_power
async def set_power(self, value: bool): """Toggle the device on and off.""" if value: status = "active" else: status = "off" # TODO WoL works when quickboot is not enabled return await self.services["system"]["setPowerStatus"](status=status)
python
async def set_power(self, value: bool): """Toggle the device on and off.""" if value: status = "active" else: status = "off" # TODO WoL works when quickboot is not enabled return await self.services["system"]["setPowerStatus"](status=status)
Toggle the device on and off.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L158-L165
rytilahti/python-songpal
songpal/device.py
Device.get_play_info
async def get_play_info(self) -> PlayInfo: """Return of the device.""" info = await self.services["avContent"]["getPlayingContentInfo"]({}) return PlayInfo.make(**info.pop())
python
async def get_play_info(self) -> PlayInfo: """Return of the device.""" info = await self.services["avContent"]["getPlayingContentInfo"]({}) return PlayInfo.make(**info.pop())
Return of the device.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L167-L170
rytilahti/python-songpal
songpal/device.py
Device.get_power_settings
async def get_power_settings(self) -> List[Setting]: """Get power settings.""" return [ Setting.make(**x) for x in await self.services["system"]["getPowerSettings"]({}) ]
python
async def get_power_settings(self) -> List[Setting]: """Get power settings.""" return [ Setting.make(**x) for x in await self.services["system"]["getPowerSettings"]({}) ]
Get power settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L172-L177
rytilahti/python-songpal
songpal/device.py
Device.set_power_settings
async def set_power_settings(self, target: str, value: str) -> None: """Set power settings.""" params = {"settings": [{"target": target, "value": value}]} return await self.services["system"]["setPowerSettings"](params)
python
async def set_power_settings(self, target: str, value: str) -> None: """Set power settings.""" params = {"settings": [{"target": target, "value": value}]} return await self.services["system"]["setPowerSettings"](params)
Set power settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L179-L182
rytilahti/python-songpal
songpal/device.py
Device.get_googlecast_settings
async def get_googlecast_settings(self) -> List[Setting]: """Get Googlecast settings.""" return [ Setting.make(**x) for x in await self.services["system"]["getWuTangInfo"]({}) ]
python
async def get_googlecast_settings(self) -> List[Setting]: """Get Googlecast settings.""" return [ Setting.make(**x) for x in await self.services["system"]["getWuTangInfo"]({}) ]
Get Googlecast settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L184-L189
rytilahti/python-songpal
songpal/device.py
Device.set_googlecast_settings
async def set_googlecast_settings(self, target: str, value: str): """Set Googlecast settings.""" params = {"settings": [{"target": target, "value": value}]} return await self.services["system"]["setWuTangInfo"](params)
python
async def set_googlecast_settings(self, target: str, value: str): """Set Googlecast settings.""" params = {"settings": [{"target": target, "value": value}]} return await self.services["system"]["setWuTangInfo"](params)
Set Googlecast settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L191-L194
rytilahti/python-songpal
songpal/device.py
Device.get_settings
async def get_settings(self) -> List[SettingsEntry]: """Get a list of available settings. See :func:request_settings_tree: for raw settings. """ settings = await self.request_settings_tree() return [SettingsEntry.make(**x) for x in settings["settings"]]
python
async def get_settings(self) -> List[SettingsEntry]: """Get a list of available settings. See :func:request_settings_tree: for raw settings. """ settings = await self.request_settings_tree() return [SettingsEntry.make(**x) for x in settings["settings"]]
Get a list of available settings. See :func:request_settings_tree: for raw settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L204-L210
rytilahti/python-songpal
songpal/device.py
Device.get_misc_settings
async def get_misc_settings(self) -> List[Setting]: """Return miscellaneous settings such as name and timezone.""" misc = await self.services["system"]["getDeviceMiscSettings"](target="") return [Setting.make(**x) for x in misc]
python
async def get_misc_settings(self) -> List[Setting]: """Return miscellaneous settings such as name and timezone.""" misc = await self.services["system"]["getDeviceMiscSettings"](target="") return [Setting.make(**x) for x in misc]
Return miscellaneous settings such as name and timezone.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L212-L215
rytilahti/python-songpal
songpal/device.py
Device.set_misc_settings
async def set_misc_settings(self, target: str, value: str): """Change miscellaneous settings.""" params = {"settings": [{"target": target, "value": value}]} return await self.services["system"]["setDeviceMiscSettings"](params)
python
async def set_misc_settings(self, target: str, value: str): """Change miscellaneous settings.""" params = {"settings": [{"target": target, "value": value}]} return await self.services["system"]["setDeviceMiscSettings"](params)
Change miscellaneous settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L217-L220
rytilahti/python-songpal
songpal/device.py
Device.get_sleep_timer_settings
async def get_sleep_timer_settings(self) -> List[Setting]: """Get sleep timer settings.""" return [ Setting.make(**x) for x in await self.services["system"]["getSleepTimerSettings"]({}) ]
python
async def get_sleep_timer_settings(self) -> List[Setting]: """Get sleep timer settings.""" return [ Setting.make(**x) for x in await self.services["system"]["getSleepTimerSettings"]({}) ]
Get sleep timer settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L231-L236
rytilahti/python-songpal
songpal/device.py
Device.get_storage_list
async def get_storage_list(self) -> List[Storage]: """Return information about connected storage devices.""" return [ Storage.make(**x) for x in await self.services["system"]["getStorageList"]({}) ]
python
async def get_storage_list(self) -> List[Storage]: """Return information about connected storage devices.""" return [ Storage.make(**x) for x in await self.services["system"]["getStorageList"]({}) ]
Return information about connected storage devices.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L238-L243
rytilahti/python-songpal
songpal/device.py
Device.get_update_info
async def get_update_info(self, from_network=True) -> SoftwareUpdateInfo: """Get information about updates.""" if from_network: from_network = "true" else: from_network = "false" # from_network = "" info = await self.services["system"]["getSWUpdateInfo"](network=from_network) return SoftwareUpdateInfo.make(**info)
python
async def get_update_info(self, from_network=True) -> SoftwareUpdateInfo: """Get information about updates.""" if from_network: from_network = "true" else: from_network = "false" # from_network = "" info = await self.services["system"]["getSWUpdateInfo"](network=from_network) return SoftwareUpdateInfo.make(**info)
Get information about updates.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L245-L253
rytilahti/python-songpal
songpal/device.py
Device.get_inputs
async def get_inputs(self) -> List[Input]: """Return list of available outputs.""" res = await self.services["avContent"]["getCurrentExternalTerminalsStatus"]() return [Input.make(services=self.services, **x) for x in res if 'meta:zone:output' not in x['meta']]
python
async def get_inputs(self) -> List[Input]: """Return list of available outputs.""" res = await self.services["avContent"]["getCurrentExternalTerminalsStatus"]() return [Input.make(services=self.services, **x) for x in res if 'meta:zone:output' not in x['meta']]
Return list of available outputs.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L259-L262
rytilahti/python-songpal
songpal/device.py
Device.get_zones
async def get_zones(self) -> List[Zone]: """Return list of available zones.""" res = await self.services["avContent"]["getCurrentExternalTerminalsStatus"]() zones = [Zone.make(services=self.services, **x) for x in res if 'meta:zone:output' in x['meta']] if not zones: raise SongpalException("Device has no zones") return zones
python
async def get_zones(self) -> List[Zone]: """Return list of available zones.""" res = await self.services["avContent"]["getCurrentExternalTerminalsStatus"]() zones = [Zone.make(services=self.services, **x) for x in res if 'meta:zone:output' in x['meta']] if not zones: raise SongpalException("Device has no zones") return zones
Return list of available zones.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L264-L270
rytilahti/python-songpal
songpal/device.py
Device.get_setting
async def get_setting(self, service: str, method: str, target: str): """Get a single setting for service. :param service: Service to query. :param method: Getter method for the setting, read from ApiMapping. :param target: Setting to query. :return: JSON response from the device. """ return await self.services[service][method](target=target)
python
async def get_setting(self, service: str, method: str, target: str): """Get a single setting for service. :param service: Service to query. :param method: Getter method for the setting, read from ApiMapping. :param target: Setting to query. :return: JSON response from the device. """ return await self.services[service][method](target=target)
Get a single setting for service. :param service: Service to query. :param method: Getter method for the setting, read from ApiMapping. :param target: Setting to query. :return: JSON response from the device.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L280-L288
rytilahti/python-songpal
songpal/device.py
Device.get_bluetooth_settings
async def get_bluetooth_settings(self) -> List[Setting]: """Get bluetooth settings.""" bt = await self.services["avContent"]["getBluetoothSettings"]({}) return [Setting.make(**x) for x in bt]
python
async def get_bluetooth_settings(self) -> List[Setting]: """Get bluetooth settings.""" bt = await self.services["avContent"]["getBluetoothSettings"]({}) return [Setting.make(**x) for x in bt]
Get bluetooth settings.
https://github.com/rytilahti/python-songpal/blob/0443de6b3d960b9067a851d82261ca00e46b4618/songpal/device.py#L290-L293