B EDbÂlã@s ddlZddlZddlZddlZddlZddlZddlTddlmZddl m Z ddl m Z ddl mZejddkrŒddlmZd d „Zn"ejdd kr®ddlmZd d „ZGd d„deƒZGdd„deƒZe d¡ae d¡ae d¡aGdd„deƒZdadd„ZdS)éN)Ú*)Ú interfaces)Ú LadonType)Ú validate_type)Ú TypeManageré)ÚdetectcCs|jS)N)Z func_name)Úf©r ú:G:\easytimepro\master/mysite/ladon\ladonizer\collection.pyÚget_function_name sr écCs|jS)N)Ú__name__)r r r r r sc@s‚eZdZdZd dd„Zdd„Zdd„Zd d „Zd d „Zd d„Z dd„Z dd„Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„ZdS)!ÚLadonServiceCollectiona™ LadonServiceCollection collects all services, methods and types for a given server-run In Ladon it is only used as a singleton global object, but this could change in time. The singleton behaviour is implemented in global_service_collection() which creates the global object the first time it is called and then returns the same object the rest of the time. add_service_method() is the most important method on this class as it is the central entry-point used by the ladonize decorator to register a service method. Ladon uses Abstract Syntax Trees (ast) to parse the source files associated with the service methods that are registered. We do that because the methods are unbound at call-time of the decorators by the Python interpreter. To actually detect the name of the class that will have the method as member we do a manual parse per source file. Example:: LadonServiceCollection + LadonServiceInfo (UserService) + LadonMethodInfo (addUser) + LadonMethodInfo (delUser) + LadonServiceInfo (RoleService) + LadonMethodInfo (addRole) + LadonMethodInfo (delRole) + LadonMethodInfo (addRoleMember) . . ÚglobalcCs(i|_i|_i|_i|_||_d|_dS)z initialize some members éN)Úsrc_infoÚ src_encodingÚservicesÚservice_and_numberÚcollection_nameÚservice_counter)Úselfrr r r Ú__init__4s zLadonServiceCollection.__init__c Cs,||jkr|j|Si|j|<t|dƒ}| ¡}| ¡t|ƒ}t |¡}~|d|j|<xÆ|jD]¼}t |ƒtj krb|}|j }|j } g} d} xz|jD]p}| rêt |ƒtj krêt |j ƒtjkrêx.t |j j dd¡¡ d¡D]} | | g7} qØWt |ƒtjkr|j } d} q”W|| | f|j||j<qbW|j|S)z} Parse a python source file at ast-level to internally acknowledge which class methods will be bound to which classes. ÚrbÚencodingTz Ú F)rÚopenÚreadÚcloserÚastÚparserZbodyÚtypeZClassDefÚlinenoZExprÚvalueZStrÚinspectZcleandocÚsÚreplaceÚsplitZ FunctionDefÚname) rÚfnameZsrc_fpÚsrcrÚaÚobjÚcÚ firstlinenoZ lastlinenoZclass_doc_linesZfirst_class_objZdoc_liner r r Ú source_info?s4       ""z"LadonServiceCollection.source_infoc OsÈ|j}|jj}|jj}| |¡}x¢| ¡D]–\}} || dkr*|| dkr*||f|jkr t||||| d|j|j |ƒ|j||f<||f|j |j<|jd7_|j||fj |f|ž|Ž} | Sq*WdS)aZ Register a class method. The method is expected to be registered a decorator and therefore unbound. If the class which the method is member of has not yet been registered a new LadonServiceInfo object will be created for it. The method itself will be associated with this object with the instantiation of a LadonMethodInfo object. rrrN) Ú __module__Ú__code__Ú co_filenameÚco_firstlinenor0ÚitemsrÚLadonServiceInforrrÚ add_method) rr Údef_argsÚdef_kwÚ modulenameZ src_fnamer/ÚsinfoZclsnameÚvÚmethodr r r Úadd_service_methodjs  *z)LadonServiceCollection.add_service_methodcCs,g}x"|j ¡D]\}}||jg7}qW|S)z0 Return a list of registered service names. )rr5Ú servicename)rÚnamesÚkr<r r r Ú servicenames‹sz#LadonServiceCollection.servicenamescCs ||f|jkr|j||fSdS)a Return a specific LadonServiceInfo object registered with a certain source file and a service name. Service names are actually class names and you cannot have 2 active classes with the same name in one module therefore this method will not end in an ambigious result. N)r)rÚ sourcefiler?r r r Úservice_by_source”sz(LadonServiceCollection.service_by_sourcecCs||jkr|j|j|SdS)z¤ Return a specific LadonServiceInfo object registered with a certain service number. Service numbers are unique, so this cannot end in an ambigious result. N)rr)rÚ servicenumberr r r Úservice_by_numberŸs z(LadonServiceCollection.service_by_numbercCsDg}x:|j ¡D],\}}|d ¡| ¡kr||j|g7}qW|S)ac Return LadonServiceInfo objects by service name. This will almost always result in a single object, but it is possible to register methods from classes with identical names but implementation in different modules. This is perfectly legal and therefore it is possible to have more than one LadonServiceInfo object returned with this method. r)rr5Úlower)rr?ÚresrAr<r r r Úservices_by_name©s z'LadonServiceCollection.services_by_namecCsR| |jj¡}|jj}x6| ¡D]*\}}||dkr ||dkr | |¡Sq WgS)a× Return LadonServiceInfo objects by referenced service function (method). This will almost always result in a single object, but it is possible to register methods from classes with identical names but implementation in different modules. This is perfectly legal and therefore it is possible to have more than one LadonServiceInfo object returned with this method. @param fn: function (method) registered within the service @rtype: [LadonMethodInfo] rr)r0r2r3r4r5rI)rÚfnr0Z source_lineÚ class_namer<r r r Úservices_by_function¸s z+LadonServiceCollection.services_by_functioncCs>d|ji}i|d<x&|j ¡D]\}}| ¡|d|<qW|S)z$ Create an serialization object Z collectionr)rrr5Ú serialize)rrHrAr;r r r rMÍs  z LadonServiceCollection.serializec Cs˜| ||¡r”||f}|j|}x|jD]}|j||kr&Pq&W|j|=|j|=i}d}x,t|j ¡ƒD]}|j|||<|d7}qfW||_||_|SdS)z«Removes a service from collection @param servicename: name of service to remove @param sourcefile: filename with service source code @rtype: LadonServiceInfo rF)Ú has_servicerrÚsortedÚkeysr) rrCr?rAÚserviceZnumZnew_service_and_numberZcounterZold_numr r r Úremove_service×s"    z%LadonServiceCollection.remove_servicecCsXg}t |j¡}xB|D]:}|d ¡| ¡kr| |d|d¡}|r||g7}qW|S)zðRemoves a service or list of services with the given name from the service collection and returns the removed elements @param servicename: name of a service to remove @rtype: [LadonServiceInfo] - list of removed service objects rr)ÚcopyrrGrR)rr?rHrrArQr r r Úservices_remove_by_nameös  z.LadonServiceCollection.services_remove_by_namecCsH|j|jf}| |j|j¡sD||j|<||j|j<|jd7_dSdS)z„Appends a new service to the end of service collection @param service: LadonServiceInfo - service info object @rtype: bool rTF)rCr?rNrrr)rrQrAr r r Úappend_services   z%LadonServiceCollection.append_servicecCs||f|jkS)z±Checks if current collection contains the service @param sourcefile: path to the source file with service definition @param servicename: name of service @rtype: bool )r)rrCr?r r r rNsz"LadonServiceCollection.has_servicecCst |j|jdœ¡S)z) Make a pretty string representation )Zcollectionnamer)ÚpprintÚpformatrr)rr r r Ú__str__!szLadonServiceCollection.__str__N)r)rr1Ú __qualname__Ú__doc__rr0r>rBrDrFrIrLrMrRrTrUrNrXr r r r rs +!     rc@speZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z dd„Z dd„Z dd„Z dd„Zdd„ZdS)r6aA LadonServiceInfo stores information about a service that has been registered using LadonServiceCollection.add_service_method(). It also aggragates all it's methods as LadonMethodInfo objects. A per service type manager (ladon.types.typemanager.TypeManager) that keeps track of the types that the service requires. cCs<||_||_||_||_||_||_||_i|_tƒ|_ dS)N) r?rErrCr:Ú doc_linesr#ÚmethodsrÚ typemanager)rr?rCr:r#r[rrr r r r/szLadonServiceInfo.__init__cOs$t||f|ž|Ž}||jt|ƒ<|S)a Add a service method by creating a LadonMethodInfo object that analyses the function in regards to it's parameters and documentation. @param f The function object of the method to add @rtype LadonMethodInfo Return the method info of the method )ÚLadonMethodInfor\r )rr r8r9r=r r r r7=szLadonServiceInfo.add_methodcCs||jkr|j|SdS)zÔ Get the LadonMethodInfo object registered with *methodname*. @param methodname The name og the service method @rtype LadonMethodInfo The method info registered with methodname or None if non-existent N)r\)rÚ methodnamer r r r=Js  zLadonServiceInfo.methodcCs<t|j ¡ƒ}| ¡g}x|D]}||j|g7}q W|S)zX Get a list of the service methods @rtype list List of LadonMethodInfo objects )Úlistr\rPÚsort)rZ method_namesÚ method_listZmnr r r rbUs  zLadonServiceInfo.method_listcCs@|j|j|jidœ}x&|j ¡D]\}}| ¡|d|<q W|S)z] make a serialization object @rtype dict A serialization dictionary for the service )r?rCrr\r\)r?rCr#r\r5rM)rrHrAZminfor r r rMbszLadonServiceInfo.serializecCs|jjS)zƒ Get a list of the primitives required by the service. @rtype list A distinct list of primitives required by this service )r]Zprimitive_list)rr r r Úprimitive_requirementsqsz'LadonServiceInfo.primitive_requirementscCs|jjS)zð Query the service's typemanager to whether lists are required by the service. This information is used by the dispatcher to filter out service interfaces that don't support lists. @rtype bool Are lists required by the service )r]Z has_lists)rr r r Úlist_support_requiredysz&LadonServiceInfo.list_support_requiredcCs|jjS)zñ Query the service's typemanager to whether dicts are required by the service. This information is used by the dispatcher to filter out service interfaces that don't support dictss. @rtype bool Are dicts required by the service )r]Z has_dicts)rr r r Údict_support_requiredƒsz&LadonServiceInfo.dict_support_requiredcCs$| | ¡¡s ||j| ¡<dSdS)zŽAppends a method defined as LadonMethodInfo object to the current service @param methodinfo: LadonMethodInfo object @rtype: boolean TF)Ú has_methodr)r\)rZ methodinfor r r Ú append_methodszLadonServiceInfo.append_methodcCs$| |¡r |j|}|j|=|SdS)z~ Removes the method with the given name from a service methods list @param methodname: name of the method to remove F)rfr\)rr_r=r r r Ú remove_method™s   zLadonServiceInfo.remove_methodcCs ||jkS)z| Checks if the method with given name is registered in the service @param methodname: name of the method to check )r\)rr_r r r rf¦szLadonServiceInfo.has_methodcCst |j|j|j|jdœ¡S)zg Create a pretty string representation of the service info object @rtype String Pretty string )r?r[rCr\)rVrWr?r[rCr\)rr r r rX®szLadonServiceInfo.__str__N)rr1rYrZrr7r=rbrMrcrdrergrhrfrXr r r r r6's       r6z"^@param\s+([_a-zA-Z0-9]+):\s*(.*)$z^@rtype:\s*(.*)$z ^\s+(\S.*)$c@sneZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zddd„Z ddd„Z ddd„Z dd„Z dd„Z dd„Zd S)r^zõ Structure for method information. Objects of this class holds method, arg and return type documentation and type-info. User-options defined via keyword args to the method like *encoding* and *allow_unsafe_conversion* are also stored here. c Ost |¡}t |¡}|r2tjddkr2t||jƒ}||_i|_|j dk|_ |j dd…|_ |j |_|j|_t|ƒ|_||_||_d|_d|_y|d|_Wn.tk rÈ}zt||jƒ‚Wdd}~XYnXg|_d|krâ|d|_d|krô|d|_|j |j¡|_d|_|jdkrtƒ|_|j dt |jƒ …|_!|j t |jƒ d…|_"t |j ƒt |ƒkrvt#||j|j|j ƒ‚t |j ƒ}t |jƒ} xÔt$t |j ƒƒD]Â} |j|j || ¡O_d} | || } | d krd } |j| } t%|j| ƒ}t&|| | ƒst'||j|j | |j| |ƒ‚|j | || | gd œ|j|j | <| rš| |j|j | d <qšWg|_(|r| )d d¡}| *d¡}d}xv|D]l}t+ ,|¡}|rö| -¡d}||jkrÄd}qŽ| -¡d .¡}|rŽ|j|d|g7<qŽt/ ,|¡}|r4d}| -¡d .¡}|rŽ|j|g7_qŽt0 ,|¡}|r’|r’|dkrj|j| .¡g7_n$|j|d| -¡d .¡g7<qŽt | .¡ƒsæ|ræ|dkrÆ|j| .¡g7_n|j|d| .¡g7<qŽd}|j(|g7_(qŽWd 1|j(¡|_dS)NrrrzUTF-8FÚrtyperZallow_unsafe_conversionéÿÿÿÿT)r)r"ÚoptionalÚdocÚdefaultz rrlÚ_rtype)2r%Z getargspecZgetdocÚsysÚ version_infoZunicoderr;Ú_argsÚkeywordsZ _has_keywordsÚargsÚ _arg_namesÚdefaultsZ _defaultsrZZ_docr Ú _func_nameÚ _arg_typesÚ _real_methodZ _encodingZ_allow_unsafe_conversionrnÚKeyErrorZReturnTypeUndefinedÚ _rtype_docr]Z analyze_paramZ_multipart_response_requiredZ_multipart_request_requiredÚtupleÚlenZ_mandatory_argsZ_optional_argsZArgDefCountMismatchÚranger"rZDefaultArgTypeMismatchZ _method_docr'r(Ú rx_doc_paramsÚmatchÚgroupsÚstripÚ rx_doc_rtypeÚrx_doc_param_linesÚjoin)rr;r r8r9ZargspecsrlZkeZalenZdlenÚargidxZ has_defaultZdefidxZdef_valZdef_typeZdoclinesZ cur_argnameZdlineZ param_matchZdocline1Z rtype_matchZparam_line_matchr r r rÂsº                      $ zLadonMethodInfo.__init__cCs|jS)zx Fetch the name of the method being mapped by this LadonMethodInfo. @param rtype String The name of the method )rv)rr r r r)gszLadonMethodInfo.namecCs(g}x|jD]}||j|g7}q W|S)zl Fetch information about this methods parameters. @rtype list A list of argument description dicts )rtrq)rZretÚargnamer r r rsos zLadonMethodInfo.argscCs| ¡|j| ¡|j|jdœS)z Serialize this method )r_rlrsriZ rtype_doc)r)rZrsrnrz)rr r r rMzszLadonMethodInfo.serializecCs|jS)zy Returns a reference to the real service method was decorated by ladonizer @rtype: function which was decorated )rx)rr r r Úget_real_method€szLadonMethodInfo.get_real_methodFNc Cs¤| |¡s t|ƒtkr|g}||||dœ|j|<|dk rF|j |¡}n$|dk r`|j |¡d}n t|jƒ}|g|j|d…<t|jƒ}|g||d…<t |ƒ|_dSdS)aAdds a new argument to the method. It is possible to add an argument at specified position by setting up the insert_before or insert_after argument name. By the way there are dedicated methods existing as aliases to an appropriate operation - see LadonMethodInfo:arg_insert_before() and LadonMethodInfo:arg_insert_after() Please, note, that only one of insert_before or insert_after parameter will be taken into account and insert_before is a high priority. It means that bypassing both parameters at a time will cause selection of insert_before behavior, insert_after will be ommited By default the argument will be added to the end of service method's arguments list Returns True if operation successfull, False otherwise @param arg_name: a name of an argument to add to a service method @param arg_type: an argument type defined for a service method @param arg_doc: a docuentation string(s) to add to a service method @param is_optional: specifies if an argument should be treated as optional or not at a service method @param insert_before: specifies a name of service method's argument before which the new argument should be added @param insert_after: specifies a name of service method's argument after which the new argument should be added @rtype: bool )rlr)rkr"NrTF) Úhas_argr"ÚstrrqrtÚindexr|r`rwr{) rÚarg_nameÚarg_typeÚarg_docÚ is_optionalÚ insert_beforeÚ insert_afterr…Úatlistr r r Úadd_argˆs$     zLadonMethodInfo.add_argcCs|j|||||dS)aL An alias for LadonMethodInfo:add_arg() with the insert_before parameter specified as ref_arg_name Returns True if operation successfull, False otherwise @param ref_arg_name: name of service method's argument before which the new argument should be added @param arg_name: a name of an argument to add to a service method @param arg_type: an argument type defined for a service method @param arg_doc: a docuentation string(s) to add to a service method @param is_optional: specifies if an argument should be treated as optional or not at a service method @rtype: bool )r)r’)rÚ ref_arg_namer‹rŒrrŽr r r Úarg_insert_before¸s z!LadonMethodInfo.arg_insert_beforecCs|j|||||dS)aJ An alias for LadonMethodInfo:add_arg() with the insert_after parameter specified as ref_arg_name Returns True if operation successfull, False otherwise @param ref_arg_name: name of service method's argument after which the new argument should be added @param arg_name: a name of an argument to add to a service method @param arg_type: an argument type defined for a service method @param arg_doc: a docuentation string(s) to add to a service method @param is_optional: specifies if an argument should be treated as optional or not at a service method @rtype: bool )r)r’)rr“r‹rŒrrŽr r r Úarg_insert_afterÆs z LadonMethodInfo.arg_insert_aftercCsR| |¡rN|j|}|j |¡}|j|=|j|=t|jƒ}||=t|ƒ|_|SdS)a{ Removes an argument with the name specified from a registered arguments for current service method Returns removed argument representation or False if argument is not present in the method's arument list @param arg_name: name of a service method's argument to remove @rtype: dict { "doc" : [str], "name" : str, "optional" : bool, "type" : LadonType } or bool False F)rˆrqrtrŠr`rwr{)rr‹Úargr…r‘r r r Ú remove_argÔs     zLadonMethodInfo.remove_argcCs ||jkS)z¦ Checks if the argument with the name specified exists in the list of service method arguments @param arg_name: name of an argument to check @rtype: bool )rq)rr‹r r r rˆêszLadonMethodInfo.has_argcCst | ¡¡S)N)rVrWrM)rr r r rXószLadonMethodInfo.__str__)FNN)F)F)rr1rYrZrr)rsrMr‡r’r”r•r—rˆrXr r r r r^»s&  0   r^cCsts tƒatS)z§ Fetch the singleton instance of LadonServiceCollection refered to as the global service collection. @rtype LadonServiceCollection The global service collection )Ú global_lscrr r r r Úglobal_service_collectionùs r™)r%r ÚrerVrorSZ!mysite.ladon.exceptions.ladonizerZ mysite.ladonrZmysite.ladon.types.ladontyperZmysite.ladon.typesrZmysite.ladon.types.typemanagerrrpZ chardet_py2rr ZchardetÚobjectrr6Úcompiler~r‚rƒr^r˜r™r r r r Ús00          =