idx
int64
0
63k
question
stringlengths
61
4.03k
target
stringlengths
6
1.23k
37,800
async def send_file ( filename : FilePath , mimetype : Optional [ str ] = None , as_attachment : bool = False , attachment_filename : Optional [ str ] = None , add_etags : bool = True , cache_timeout : Optional [ int ] = None , conditional : bool = False , last_modified : Optional [ datetime ] = None , ) -> Response : ...
Return a Reponse to send the filename given .
37,801
def _render_frame ( self ) : frame = self . frame ( ) output = '\r{0}' . format ( frame ) self . clear ( ) try : self . _stream . write ( output ) except UnicodeEncodeError : self . _stream . write ( encode_utf_8_text ( output ) )
Renders the frame on the line after clearing it .
37,802
def get_environment ( ) : try : from IPython import get_ipython except ImportError : return 'terminal' try : shell = get_ipython ( ) . __class__ . __name__ if shell == 'ZMQInteractiveShell' : return 'jupyter' elif shell == 'TerminalInteractiveShell' : return 'ipython' else : return 'terminal' except NameError : return ...
Get the environment in which halo is running
37,803
def is_text_type ( text ) : if isinstance ( text , six . text_type ) or isinstance ( text , six . string_types ) : return True return False
Check if given parameter is a string or not
37,804
def find_stateless_by_name ( name ) : try : dsa_app = StatelessApp . objects . get ( app_name = name ) return dsa_app . as_dash_app ( ) except : pass dash_app = get_stateless_by_name ( name ) dsa_app = StatelessApp ( app_name = name ) dsa_app . save ( ) return dash_app
Find stateless app given its name
37,805
def as_dash_app ( self ) : dateless_dash_app = getattr ( self , '_stateless_dash_app_instance' , None ) if not dateless_dash_app : dateless_dash_app = get_stateless_by_name ( self . app_name ) setattr ( self , '_stateless_dash_app_instance' , dateless_dash_app ) return dateless_dash_app
Return a DjangoDash instance of the dash application
37,806
def handle_current_state ( self ) : if getattr ( self , '_current_state_hydrated_changed' , False ) and self . save_on_change : new_base_state = json . dumps ( getattr ( self , '_current_state_hydrated' , { } ) ) if new_base_state != self . base_state : self . base_state = new_base_state self . save ( )
Check to see if the current hydrated state and the saved state are different .
37,807
def have_current_state_entry ( self , wid , key ) : 'Return True if there is a cached current state for this app' cscoll = self . current_state ( ) c_state = cscoll . get ( wid , { } ) return key in c_state
Return True if there is a cached current state for this app
37,808
def current_state ( self ) : c_state = getattr ( self , '_current_state_hydrated' , None ) if not c_state : c_state = json . loads ( self . base_state ) setattr ( self , '_current_state_hydrated' , c_state ) setattr ( self , '_current_state_hydrated_changed' , False ) return c_state
Return the current internal state of the model instance .
37,809
def as_dash_instance ( self , cache_id = None ) : 'Return a dash application instance for this model instance' dash_app = self . stateless_app . as_dash_app ( ) base = self . current_state ( ) return dash_app . do_form_dash_instance ( replacements = base , specific_identifier = self . slug , cache_id = cache_id )
Return a dash application instance for this model instance
37,810
def _get_base_state ( self ) : base_app_inst = self . stateless_app . as_dash_app ( ) . as_dash_instance ( ) base_resp = base_app_inst . locate_endpoint_function ( 'dash-layout' ) ( ) base_obj = json . loads ( base_resp . data . decode ( 'utf-8' ) ) obj = { } base_app_inst . walk_tree_and_extract ( base_obj , obj ) ret...
Get the base state of the object as defined by the app . layout code as a python dict
37,811
def populate_values ( self ) : obj = self . _get_base_state ( ) self . base_state = json . dumps ( obj )
Add values from the underlying dash layout configuration
37,812
def locate_item ( ident , stateless = False , cache_id = None ) : if stateless : dash_app = find_stateless_by_name ( ident ) else : dash_app = get_object_or_404 ( DashApp , slug = ident ) app = dash_app . as_dash_instance ( cache_id = cache_id ) return dash_app , app
Locate a dash application given either the slug of an instance or the name for a stateless app
37,813
def send_to_pipe_channel ( channel_name , label , value ) : 'Send message through pipe to client component' async_to_sync ( async_send_to_pipe_channel ) ( channel_name = channel_name , label = label , value = value )
Send message through pipe to client component
37,814
async def async_send_to_pipe_channel ( channel_name , label , value ) : 'Send message asynchronously through pipe to client component' pcn = _form_pipe_channel_name ( channel_name ) channel_layer = get_channel_layer ( ) await channel_layer . group_send ( pcn , { "type" : "pipe.value" , "label" : label , "value" : value...
Send message asynchronously through pipe to client component
37,815
def pipe_value ( self , message ) : 'Send a new value into the ws pipe' jmsg = json . dumps ( message ) self . send ( jmsg )
Send a new value into the ws pipe
37,816
def update_pipe_channel ( self , uid , channel_name , label ) : pipe_group_name = _form_pipe_channel_name ( channel_name ) if self . channel_layer : current = self . channel_maps . get ( uid , None ) if current != pipe_group_name : if current : async_to_sync ( self . channel_layer . group_discard ) ( current , self . c...
Update this consumer to listen on channel_name for the js widget associated with uid
37,817
def store_initial_arguments ( request , initial_arguments = None ) : 'Store initial arguments, if any, and return a cache identifier' if initial_arguments is None : return None cache_id = "dpd-initial-args-%s" % str ( uuid . uuid4 ( ) ) . replace ( '-' , '' ) if initial_argument_location ( ) : cache . set ( cache_id , ...
Store initial arguments if any and return a cache identifier
37,818
def get_initial_arguments ( request , cache_id = None ) : 'Extract initial arguments for the dash app' if cache_id is None : return None if initial_argument_location ( ) : return cache . get ( cache_id ) return request . session [ cache_id ]
Extract initial arguments for the dash app
37,819
def dependencies ( request , ident , stateless = False , ** kwargs ) : 'Return the dependencies' _ , app = DashApp . locate_item ( ident , stateless ) with app . app_context ( ) : view_func = app . locate_endpoint_function ( 'dash-dependencies' ) resp = view_func ( ) return HttpResponse ( resp . data , content_type = r...
Return the dependencies
37,820
def layout ( request , ident , stateless = False , cache_id = None , ** kwargs ) : 'Return the layout of the dash application' _ , app = DashApp . locate_item ( ident , stateless ) view_func = app . locate_endpoint_function ( 'dash-layout' ) resp = view_func ( ) initial_arguments = get_initial_arguments ( request , cac...
Return the layout of the dash application
37,821
def update ( request , ident , stateless = False , ** kwargs ) : 'Generate update json response' dash_app , app = DashApp . locate_item ( ident , stateless ) request_body = json . loads ( request . body . decode ( 'utf-8' ) ) if app . use_dash_dispatch ( ) : view_func = app . locate_endpoint_function ( 'dash-update-com...
Generate update json response
37,822
def main_view ( request , ident , stateless = False , cache_id = None , ** kwargs ) : 'Main view for a dash app' _ , app = DashApp . locate_item ( ident , stateless , cache_id = cache_id ) view_func = app . locate_endpoint_function ( ) resp = view_func ( ) return HttpResponse ( resp )
Main view for a dash app
37,823
def app_assets ( request , ** kwargs ) : 'Return a local dash app asset, served up through the Django static framework' get_params = request . GET . urlencode ( ) extra_part = "" if get_params : redone_url = "/static/dash/assets/%s?%s" % ( extra_part , get_params ) else : redone_url = "/static/dash/assets/%s" % extra_p...
Return a local dash app asset served up through the Django static framework
37,824
def add_to_session ( request , template_name = "index.html" , ** kwargs ) : 'Add some info to a session in a place that django-plotly-dash can pass to a callback' django_plotly_dash = request . session . get ( "django_plotly_dash" , dict ( ) ) session_add_count = django_plotly_dash . get ( 'add_counter' , 0 ) django_pl...
Add some info to a session in a place that django - plotly - dash can pass to a callback
37,825
def asset_redirection ( request , path , ident = None , stateless = False , ** kwargs ) : 'Redirect static assets for a component' X , app = DashApp . locate_item ( ident , stateless ) static_path = X . get_asset_static_url ( path ) return redirect ( static_path )
Redirect static assets for a component
37,826
def dash_example_1_view ( request , template_name = "demo_six.html" , ** kwargs ) : 'Example view that inserts content into the dash context passed to the dash application' context = { } dash_context = request . session . get ( "django_plotly_dash" , dict ( ) ) dash_context [ 'django_to_dash_context' ] = "I am Dash rec...
Example view that inserts content into the dash context passed to the dash application
37,827
def session_state_view ( request , template_name , ** kwargs ) : 'Example view that exhibits the use of sessions to store state' session = request . session demo_count = session . get ( 'django_plotly_dash' , { } ) ind_use = demo_count . get ( 'ind_use' , 0 ) ind_use += 1 demo_count [ 'ind_use' ] = ind_use context = { ...
Example view that exhibits the use of sessions to store state
37,828
def adjust_response ( self , response ) : 'Locate placeholder magic strings and replace with content' try : c1 = self . _replace ( response . content , self . header_placeholder , self . embedded_holder . css ) response . content = self . _replace ( c1 , self . footer_placeholder , "\n" . join ( [ self . embedded_holde...
Locate placeholder magic strings and replace with content
37,829
def callback_c ( * args , ** kwargs ) : 'Update the output following a change of the input selection' session_state = kwargs [ 'session_state' ] calls_so_far = session_state . get ( 'calls_so_far' , 0 ) session_state [ 'calls_so_far' ] = calls_so_far + 1 user_counts = session_state . get ( 'user_counts' , None ) user_n...
Update the output following a change of the input selection
37,830
def callback_liveIn_button_press ( red_clicks , blue_clicks , green_clicks , rc_timestamp , bc_timestamp , gc_timestamp , ** kwargs ) : 'Input app button pressed, so do something interesting' if not rc_timestamp : rc_timestamp = 0 if not bc_timestamp : bc_timestamp = 0 if not gc_timestamp : gc_timestamp = 0 if ( rc_tim...
Input app button pressed so do something interesting
37,831
def generate_liveOut_layout ( ) : 'Generate the layout per-app, generating each tine a new uuid for the state_uid argument' return html . Div ( [ dpd . Pipe ( id = "named_count_pipe" , value = None , label = "named_counts" , channel_name = "live_button_counter" ) , html . Div ( id = "internal_state" , children = "No st...
Generate the layout per - app generating each tine a new uuid for the state_uid argument
37,832
def callback_liveOut_pipe_in ( named_count , state_uid , ** kwargs ) : 'Handle something changing the value of the input pipe or the associated state uid' cache_key = _get_cache_key ( state_uid ) state = cache . get ( cache_key ) if not state : state = { } if not named_count : named_count = { } user = named_count . get...
Handle something changing the value of the input pipe or the associated state uid
37,833
def callback_show_timeseries ( internal_state_string , state_uid , ** kwargs ) : 'Build a timeseries from the internal state' cache_key = _get_cache_key ( state_uid ) state = cache . get ( cache_key ) if not state : state = { } colour_series = { } colors = { 'red' : '#FF0000' , 'blue' : '#0000FF' , 'green' : '#00FF00' ...
Build a timeseries from the internal state
37,834
def session_demo_danger_callback ( da_children , session_state = None , ** kwargs ) : 'Update output based just on state' if not session_state : return "Session state not yet available" return "Session state contains: " + str ( session_state . get ( 'bootstrap_demo_state' , "NOTHING" ) ) + " and the page render count i...
Update output based just on state
37,835
def session_demo_alert_callback ( n_clicks , session_state = None , ** kwargs ) : 'Output text based on both app state and session state' if session_state is None : raise NotImplementedError ( "Cannot handle a missing session state" ) csf = session_state . get ( 'bootstrap_demo_state' , None ) if not csf : csf = dict (...
Output text based on both app state and session state
37,836
def add_usable_app ( name , app ) : 'Add app to local registry by name' name = slugify ( name ) global usable_apps usable_apps [ name ] = app return name
Add app to local registry by name
37,837
def get_base_pathname ( self , specific_identifier , cache_id ) : 'Base path name of this instance, taking into account any state or statelessness' if not specific_identifier : app_pathname = "%s:app-%s" % ( app_name , main_view_label ) ndid = self . _uid else : app_pathname = "%s:%s" % ( app_name , main_view_label ) n...
Base path name of this instance taking into account any state or statelessness
37,838
def do_form_dash_instance ( self , replacements = None , specific_identifier = None , cache_id = None ) : 'Perform the act of constructing a Dash instance taking into account state' ndid , base_pathname = self . get_base_pathname ( specific_identifier , cache_id ) return self . form_dash_instance ( replacements , ndid ...
Perform the act of constructing a Dash instance taking into account state
37,839
def form_dash_instance ( self , replacements = None , ndid = None , base_pathname = None ) : 'Construct a Dash instance taking into account state' if ndid is None : ndid = self . _uid rd = WrappedDash ( base_pathname = base_pathname , expanded_callbacks = self . _expanded_callbacks , replacements = replacements , ndid ...
Construct a Dash instance taking into account state
37,840
def callback ( self , output , inputs = None , state = None , events = None ) : 'Form a callback function by wrapping, in the same way as the underlying Dash application would' callback_set = { 'output' : output , 'inputs' : inputs and inputs or dict ( ) , 'state' : state and state or dict ( ) , 'events' : events and e...
Form a callback function by wrapping in the same way as the underlying Dash application would
37,841
def expanded_callback ( self , output , inputs = [ ] , state = [ ] , events = [ ] ) : self . _expanded_callbacks = True return self . callback ( output , inputs , state , events )
Form an expanded callback .
37,842
def augment_initial_layout ( self , base_response , initial_arguments = None ) : 'Add application state to initial values' if self . use_dash_layout ( ) and not initial_arguments and False : return base_response . data , base_response . mimetype baseDataInBytes = base_response . data baseData = json . loads ( baseDataI...
Add application state to initial values
37,843
def walk_tree_and_extract ( self , data , target ) : 'Walk tree of properties and extract identifiers and associated values' if isinstance ( data , dict ) : for key in [ 'children' , 'props' , ] : self . walk_tree_and_extract ( data . get ( key , None ) , target ) ident = data . get ( 'id' , None ) if ident is not None...
Walk tree of properties and extract identifiers and associated values
37,844
def walk_tree_and_replace ( self , data , overrides ) : if isinstance ( data , dict ) : response = { } replacements = { } thisID = data . get ( 'id' , None ) if thisID is not None : replacements = overrides . get ( thisID , None ) if overrides else None if not replacements : replacements = self . _replacements . get ( ...
Walk the tree . Rely on json decoding to insert instances of dict and list ie we use a dna test for anatine rather than our eyes and ears ...
37,845
def locate_endpoint_function ( self , name = None ) : 'Locate endpoint function given name of view' if name is not None : ep = "%s_%s" % ( self . _base_pathname , name ) else : ep = self . _base_pathname return self . _notflask . endpoints [ ep ] [ 'view_func' ]
Locate endpoint function given name of view
37,846
def layout ( self , value ) : 'Overloaded layout function to fix component names as needed' if self . _adjust_id : self . _fix_component_id ( value ) return Dash . layout . fset ( self , value )
Overloaded layout function to fix component names as needed
37,847
def _fix_component_id ( self , component ) : 'Fix name of component ad all of its children' theID = getattr ( component , "id" , None ) if theID is not None : setattr ( component , "id" , self . _fix_id ( theID ) ) try : for c in component . children : self . _fix_component_id ( c ) except : pass
Fix name of component ad all of its children
37,848
def _fix_callback_item ( self , item ) : 'Update component identifier' item . component_id = self . _fix_id ( item . component_id ) return item
Update component identifier
37,849
def callback ( self , output , inputs = [ ] , state = [ ] , events = [ ] ) : 'Invoke callback, adjusting variable names as needed' if isinstance ( output , ( list , tuple ) ) : fixed_outputs = [ self . _fix_callback_item ( x ) for x in output ] raise NotImplementedError ( "django-plotly-dash cannot handle multiple call...
Invoke callback adjusting variable names as needed
37,850
def dispatch ( self ) : 'Perform dispatch, using request embedded within flask global state' import flask body = flask . request . get_json ( ) return self . dispatch_with_args ( body , argMap = dict ( ) )
Perform dispatch using request embedded within flask global state
37,851
def dispatch_with_args ( self , body , argMap ) : 'Perform callback dispatching, with enhanced arguments and recording of response' inputs = body . get ( 'inputs' , [ ] ) state = body . get ( 'state' , [ ] ) output = body [ 'output' ] try : output_id = output [ 'id' ] output_property = output [ 'property' ] target_id =...
Perform callback dispatching with enhanced arguments and recording of response
37,852
def extra_html_properties ( self , prefix = None , postfix = None , template_type = None ) : prefix = prefix if prefix else "django-plotly-dash" post_part = "-%s" % postfix if postfix else "" template_type = template_type if template_type else "iframe" slugified_id = self . slugified_id ( ) return "%(prefix)s %(prefix)...
Return extra html properties to allow individual apps to be styled separately .
37,853
def plotly_direct ( context , name = None , slug = None , da = None ) : 'Direct insertion of a Dash app' da , app = _locate_daapp ( name , slug , da ) view_func = app . locate_endpoint_function ( ) eh = context . request . dpd_content_handler . embedded_holder app . set_embedded ( eh ) try : resp = view_func ( ) finall...
Direct insertion of a Dash app
37,854
def plotly_app_identifier ( name = None , slug = None , da = None , postfix = None ) : 'Return a slug-friendly identifier' da , app = _locate_daapp ( name , slug , da ) slugified_id = app . slugified_id ( ) if postfix : return "%s-%s" % ( slugified_id , postfix ) return slugified_id
Return a slug - friendly identifier
37,855
def plotly_class ( name = None , slug = None , da = None , prefix = None , postfix = None , template_type = None ) : 'Return a string of space-separated class names' da , app = _locate_daapp ( name , slug , da ) return app . extra_html_properties ( prefix = prefix , postfix = postfix , template_type = template_type )
Return a string of space - separated class names
37,856
def parse_wyckoff_csv ( wyckoff_file ) : rowdata = [ ] points = [ ] hP_nums = [ 433 , 436 , 444 , 450 , 452 , 458 , 460 ] for i , line in enumerate ( wyckoff_file ) : if line . strip ( ) == 'end of data' : break rowdata . append ( line . strip ( ) . split ( ':' ) ) if rowdata [ - 1 ] [ 0 ] . isdigit ( ) : points . appe...
Parse Wyckoff . csv
37,857
def get_site_symmetries ( wyckoff ) : ssyms = [ ] for w in wyckoff : ssyms += [ "\"%-6s\"" % w_s [ 'site_symmetry' ] for w_s in w [ 'wyckoff' ] ] damp_array_site_symmetries ( ssyms )
List up site symmetries
37,858
def transform_model ( cls ) -> None : if cls . name != "Model" : appname = "models" for mcls in cls . get_children ( ) : if isinstance ( mcls , ClassDef ) : for attr in mcls . get_children ( ) : if isinstance ( attr , Assign ) : if attr . targets [ 0 ] . name == "app" : appname = attr . value . value mname = "{}.{}" . ...
Anything that uses the ModelMeta needs _meta and id . Also keep track of relationships and make them in the related model class .
37,859
def apply_type_shim ( cls , _context = None ) -> Iterator : if cls . name in [ "IntField" , "SmallIntField" ] : base_nodes = scoped_nodes . builtin_lookup ( "int" ) elif cls . name in [ "CharField" , "TextField" ] : base_nodes = scoped_nodes . builtin_lookup ( "str" ) elif cls . name == "BooleanField" : base_nodes = sc...
Morphs model fields to representative type
37,860
def list_encoder ( values , instance , field : Field ) : return [ field . to_db_value ( element , instance ) for element in values ]
Encodes an iterable of a given field into a database - compatible format .
37,861
async def add ( self , * instances , using_db = None ) -> None : if not instances : return if self . instance . id is None : raise OperationalError ( "You should first call .save() on {model}" . format ( model = self . instance ) ) db = using_db if using_db else self . model . _meta . db through_table = Table ( self . ...
Adds one or more of instances to the relation .
37,862
async def clear ( self , using_db = None ) -> None : db = using_db if using_db else self . model . _meta . db through_table = Table ( self . field . through ) query = ( db . query_class . from_ ( through_table ) . where ( getattr ( through_table , self . field . backward_key ) == self . instance . id ) . delete ( ) ) a...
Clears ALL relations .
37,863
async def remove ( self , * instances , using_db = None ) -> None : db = using_db if using_db else self . model . _meta . db if not instances : raise OperationalError ( "remove() called on no instances" ) through_table = Table ( self . field . through ) if len ( instances ) == 1 : condition = ( getattr ( through_table ...
Removes one or more of instances from the relation .
37,864
def register_tortoise ( app : Quart , config : Optional [ dict ] = None , config_file : Optional [ str ] = None , db_url : Optional [ str ] = None , modules : Optional [ Dict [ str , List [ str ] ] ] = None , generate_schemas : bool = False , ) -> None : @ app . before_serving async def init_orm ( ) : await Tortoise . ...
Registers before_serving and after_serving hooks to set - up and tear - down Tortoise - ORM inside a Quart service . It also registers a CLI command generate_schemas that will generate the schemas .
37,865
def run_async ( coro : Coroutine ) -> None : loop = asyncio . get_event_loop ( ) try : loop . run_until_complete ( coro ) finally : loop . run_until_complete ( Tortoise . close_connections ( ) )
Simple async runner that cleans up DB connections on exit . This is meant for simple scripts .
37,866
async def init ( cls , config : Optional [ dict ] = None , config_file : Optional [ str ] = None , _create_db : bool = False , db_url : Optional [ str ] = None , modules : Optional [ Dict [ str , List [ str ] ] ] = None , ) -> None : if cls . _inited : await cls . close_connections ( ) await cls . _reset_apps ( ) if in...
Sets up Tortoise - ORM .
37,867
def in_transaction ( connection_name : Optional [ str ] = None ) -> BaseTransactionWrapper : connection = _get_connection ( connection_name ) return connection . _in_transaction ( )
Transaction context manager .
37,868
def atomic ( connection_name : Optional [ str ] = None ) -> Callable : def wrapper ( func ) : @ wraps ( func ) async def wrapped ( * args , ** kwargs ) : connection = _get_connection ( connection_name ) async with connection . _in_transaction ( ) : return await func ( * args , ** kwargs ) return wrapped return wrapper
Transaction decorator .
37,869
async def start_transaction ( connection_name : Optional [ str ] = None ) -> BaseTransactionWrapper : connection = _get_connection ( connection_name ) transaction = connection . _in_transaction ( ) await transaction . start ( ) return transaction
Function to manually control your transaction .
37,870
def limit ( self , limit : int ) -> "QuerySet" : queryset = self . _clone ( ) queryset . _limit = limit return queryset
Limits QuerySet to given length .
37,871
def offset ( self , offset : int ) -> "QuerySet" : queryset = self . _clone ( ) queryset . _offset = offset if self . capabilities . requires_limit and queryset . _limit is None : queryset . _limit = 1000000 return queryset
Query offset for QuerySet .
37,872
def annotate ( self , ** kwargs ) -> "QuerySet" : queryset = self . _clone ( ) for key , aggregation in kwargs . items ( ) : if not isinstance ( aggregation , Aggregate ) : raise TypeError ( "value is expected to be Aggregate instance" ) queryset . _annotations [ key ] = aggregation from tortoise . models import get_fi...
Annotate result with aggregation result .
37,873
def values_list ( self , * fields_ : str , flat : bool = False ) -> "ValuesListQuery" : return ValuesListQuery ( db = self . _db , model = self . model , q_objects = self . _q_objects , flat = flat , fields_for_select_list = fields_ , distinct = self . _distinct , limit = self . _limit , offset = self . _offset , order...
Make QuerySet returns list of tuples for given args instead of objects . If flat = True and only one arg is passed can return flat list .
37,874
def values ( self , * args : str , ** kwargs : str ) -> "ValuesQuery" : fields_for_select = { } for field in args : if field in fields_for_select : raise FieldError ( "Duplicate key {}" . format ( field ) ) fields_for_select [ field ] = field for return_as , field in kwargs . items ( ) : if return_as in fields_for_sele...
Make QuerySet return dicts instead of objects .
37,875
def delete ( self ) -> "DeleteQuery" : return DeleteQuery ( db = self . _db , model = self . model , q_objects = self . _q_objects , annotations = self . _annotations , custom_filters = self . _custom_filters , )
Delete all objects in QuerySet .
37,876
def update ( self , ** kwargs ) -> "UpdateQuery" : return UpdateQuery ( db = self . _db , model = self . model , update_kwargs = kwargs , q_objects = self . _q_objects , annotations = self . _annotations , custom_filters = self . _custom_filters , )
Update all objects in QuerySet with given kwargs .
37,877
def count ( self ) -> "CountQuery" : return CountQuery ( db = self . _db , model = self . model , q_objects = self . _q_objects , annotations = self . _annotations , custom_filters = self . _custom_filters , )
Return count of objects in queryset instead of objects .
37,878
def first ( self ) -> "QuerySet" : queryset = self . _clone ( ) queryset . _limit = 1 queryset . _single = True return queryset
Limit queryset to one object and return one object instead of list .
37,879
def get ( self , * args , ** kwargs ) -> "QuerySet" : queryset = self . filter ( * args , ** kwargs ) queryset . _limit = 2 queryset . _get = True return queryset
Fetch exactly one object matching the parameters .
37,880
async def explain ( self ) -> Any : if self . _db is None : self . _db = self . model . _meta . db return await self . _db . executor_class ( model = self . model , db = self . _db ) . execute_explain ( self . _make_query ( ) )
Fetch and return information about the query execution plan .
37,881
def using_db ( self , _db : BaseDBAsyncClient ) -> "QuerySet" : queryset = self . _clone ( ) queryset . _db = _db return queryset
Executes query in provided db client . Useful for transactions workaround .
37,882
def _check_unique_together ( cls ) : if cls . _meta . unique_together is None : return if not isinstance ( cls . _meta . unique_together , ( tuple , list ) ) : raise ConfigurationError ( "'{}.unique_together' must be a list or tuple." . format ( cls . __name__ ) ) elif any ( not isinstance ( unique_fields , ( tuple , l...
Check the value of unique_together option .
37,883
def write_epub ( name , book , options = None ) : epub = EpubWriter ( name , book , options ) epub . process ( ) try : epub . write ( ) except IOError : pass
Creates epub file with the content defined in EpubBook .
37,884
def read_epub ( name , options = None ) : reader = EpubReader ( name , options ) book = reader . load ( ) reader . process ( ) return book
Creates new instance of EpubBook with the content defined in the input file .
37,885
def get_type ( self ) : _ , ext = zip_path . splitext ( self . get_name ( ) ) ext = ext . lower ( ) for uid , ext_list in six . iteritems ( ebooklib . EXTENSIONS ) : if ext in ext_list : return uid return ebooklib . ITEM_UNKNOWN
Guess type according to the file extension . Might not be the best way how to do it but it works for now .
37,886
def add_link ( self , ** kwgs ) : self . links . append ( kwgs ) if kwgs . get ( 'type' ) == 'text/javascript' : if 'scripted' not in self . properties : self . properties . append ( 'scripted' )
Add additional link to the document . Links will be embeded only inside of this document .
37,887
def get_links_of_type ( self , link_type ) : return ( link for link in self . links if link . get ( 'type' , '' ) == link_type )
Returns list of additional links of specific type .
37,888
def add_item ( self , item ) : if item . get_type ( ) == ebooklib . ITEM_STYLE : self . add_link ( href = item . get_name ( ) , rel = 'stylesheet' , type = 'text/css' ) if item . get_type ( ) == ebooklib . ITEM_SCRIPT : self . add_link ( src = item . get_name ( ) , type = 'text/javascript' )
Add other item to this document . It will create additional links according to the item type .
37,889
def reset ( self ) : "Initialises all needed variables to default values" self . metadata = { } self . items = [ ] self . spine = [ ] self . guide = [ ] self . pages = [ ] self . toc = [ ] self . bindings = [ ] self . IDENTIFIER_ID = 'id' self . FOLDER_NAME = 'EPUB' self . _id_html = 0 self . _id_image = 0 self . _id_s...
Initialises all needed variables to default values
37,890
def set_identifier ( self , uid ) : self . uid = uid self . set_unique_metadata ( 'DC' , 'identifier' , self . uid , { 'id' : self . IDENTIFIER_ID } )
Sets unique id for this epub
37,891
def set_title ( self , title ) : self . title = title self . add_metadata ( 'DC' , 'title' , self . title )
Set title . You can set multiple titles .
37,892
def set_cover ( self , file_name , content , create_page = True ) : c0 = EpubCover ( file_name = file_name ) c0 . content = content self . add_item ( c0 ) if create_page : c1 = EpubCoverHtml ( image_name = file_name ) self . add_item ( c1 ) self . add_metadata ( None , 'meta' , '' , OrderedDict ( [ ( 'name' , 'cover' )...
Set cover and create cover document if needed .
37,893
def add_author ( self , author , file_as = None , role = None , uid = 'creator' ) : "Add author for this document" self . add_metadata ( 'DC' , 'creator' , author , { 'id' : uid } ) if file_as : self . add_metadata ( None , 'meta' , file_as , { 'refines' : '#' + uid , 'property' : 'file-as' , 'scheme' : 'marc:relators'...
Add author for this document
37,894
def add_item ( self , item ) : if item . media_type == '' : ( has_guessed , media_type ) = guess_type ( item . get_name ( ) . lower ( ) ) if has_guessed : if media_type is not None : item . media_type = media_type else : item . media_type = has_guessed else : item . media_type = 'application/octet-stream' if not item ....
Add additional item to the book . If not defined media type and chapter id will be defined for the item .
37,895
def get_item_with_id ( self , uid ) : for item in self . get_items ( ) : if item . id == uid : return item return None
Returns item for defined UID .
37,896
def get_item_with_href ( self , href ) : for item in self . get_items ( ) : if item . get_name ( ) == href : return item return None
Returns item for defined HREF .
37,897
def get_items_of_type ( self , item_type ) : return ( item for item in self . items if item . get_type ( ) == item_type )
Returns all items of specified type .
37,898
def get_items_of_media_type ( self , media_type ) : return ( item for item in self . items if item . media_type == media_type )
Returns all items of specified media type .
37,899
def main ( ) : import argparse parser = argparse . ArgumentParser ( description = "ftfy (fixes text for you), version %s" % __version__ ) parser . add_argument ( 'filename' , default = '-' , nargs = '?' , help = 'The file whose Unicode is to be fixed. Defaults ' 'to -, meaning standard input.' ) parser . add_argument (...
Run ftfy as a command - line utility .