Glossary¶
- aiodns
An python package for asynchronous DNS resolution.
- aiohttp
http client/server framework async_v20 use’s to communicate asynchronously.
- annotation
Used to describe what type an argument takes
- arguments
- are values passed to a function
- async_v20
The name of the package this documentation is documenting
- asyncio
The library for writing single-threaded concurrent code using coroutines, multiplexing I/O access over sockets and other resources, running network clients and servers, and other related primitives.
Reference implementation of PEP 3156
- attribute
- An attribute is the term used to describe variables associated with a class that contains information about that class’ state.
- attributes
- plural of attribute
- await
- Python syntax to execute a coroutine inside an asynchronous function
- callable
- Any object that can be called. Use
callable()to check that. - camelCase
- A style of text that uses capital letters to separate words
- cchardet
cChardet is high speed universal character encoding detector - binding to charsetdetect.
- class
Classes provide a means of bundling data and functionality together. Creating a new class creates a new type of object, allowing new instances of that type to be made. Each class instance can have attributes attached to it for maintaining its state. Class instances can also have methods (defined by its class) for modifying its state.
- concurrent
- The process by which a single threaded application switches between different tasks. Typically done to prevent waiting for I/O bound operations
- context manager
- A Python programming concept that defines enter and exit methods. Used to handle set-up and tear-down tasks
- coroutine
- A python object that supports asynchronous execution
- coroutines
- plural of coroutine
- docstring
text placed below a function or class definition that documents the function or class
- environment variable
- An environment variable is a dynamic-named value that can affect the way running processes will behave on a computer. They are part of the environment in which a process runs
- http
Stands for Hyper Text Transfer Protocol
- JSON
JavaScript Object Notation
- key
- The value used to index a dictionary
- metaclass
A python class definition that inherits from type. It allows programmers to customize class creation as if they typed the entire class
https://stackoverflow.com/questions/100003/what-is-a-metaclass-in-python
- OANDA
- The name of the Foreign Exchange (FOREX) broker async_v20 communicates with
- OandaClient
- The client class definition async_v20 exposes
- pandas
a Python package providing fast, flexible, and expressive data structures designed to make working with “relational” or “labeled” data both easy and intuitive
- python
Programming language
- snake_case
- a style of text that uses underscores to separate words
- status
When prefixed with http. Refers to a 3 digit number with pre-assigned meaning.
https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Status_codes
- token
A 65 character string used to uniquely identify and authorise access to the OANDA v20 API
- Example:
- 810492ace47473fa9f72c0eeecd33657-1eae8a55f01431bdd370206f69071e5f
- type
In computer science and computer programming, a data type or simply type is a classification of data which tells the compiler or interpreter how the programmer intends to use the data.
- virtual environment
A self-contained directory tree that contains a Python installation for a particular version of Python, plus a number of additional packages.