
    Xhp                     >    d Z ddlmZ  G d de      Z G d d      Zy)zbSherlock Result Module

This module defines various objects for recording the results of queries.
    )Enumc                   *    e Zd ZdZdZdZdZdZdZd Z	y)	QueryStatuszUQuery Status Enumeration.

    Describes status of query about a given username.
    Claimed	AvailableUnknownIllegalWAFc                     | j                   S )Convert Object To String.

        Keyword Arguments:
        self                   -- This object.

        Return Value:
        Nicely formatted string to get information about this object.
        )value)selfs    ?/var/www/betterdocs.net/sherlock_api/sherlock_project/result.py__str__zQueryStatus.__str__   s     zz    N)
__name__
__module____qualname____doc__CLAIMED	AVAILABLEUNKNOWNILLEGALr
   r    r   r   r   r      s'     GIGGC	r   r   c                        e Zd ZdZ	 ddZd Zy)QueryResultzPQuery Result Object.

    Describes result of query about a given username.
    Nc                 X    || _         || _        || _        || _        || _        || _        y)aE  Create Query Result Object.

        Contains information about a specific method of detecting usernames on
        a given type of web sites.

        Keyword Arguments:
        self                   -- This object.
        username               -- String indicating username that query result
                                  was about.
        site_name              -- String which identifies site.
        site_url_user          -- String containing URL for username on site.
                                  NOTE:  The site may or may not exist:  this
                                         just indicates what the name would
                                         be, if it existed.
        status                 -- Enumeration of type QueryStatus() indicating
                                  the status of the query.
        query_time             -- Time (in seconds) required to perform query.
                                  Default of None.
        context                -- String indicating any additional context
                                  about the query.  For example, if there was
                                  an error, this might indicate the type of
                                  error that occurred.
                                  Default of None.

        Return Value:
        Nothing.
        N)username	site_namesite_url_userstatus
query_timecontext)r   r   r   r    r!   r"   r#   s          r   __init__zQueryResult.__init__#   s2    < &&*#'$r   c                 n    t        | j                        }| j                  |d| j                   dz  }|S )r   z ())strr!   r#   )r   r!   s     r   r   zQueryResult.__str__J   s:     T[[!<<# 4<<.**Fr   )NN)r   r   r   r   r$   r   r   r   r   r   r      s    
 +/%Nr   r   N)r   enumr   r   r   r   r   r   <module>r)      s%    $ ,; ;r   