Python.LORIS.query

Complexity

Total Complexity

7

Size/Duplication

Total Lines	123
Duplicated Lines	54.47 %

Importance

Changes

0

4 Functions

Rating	Name	Duplication	Size	Complexity
A	login()	0	29	1
A	putCNBP()	24	24	2
A	postCNBP()	23	23	2
A	getCNBP()	20	20	2

import requests

This module should have a docstring.

import logging

standard import "import logging" should be placed before "import requests"

import sys

standard import "import sys" should be placed before "import requests"

import os

standard import "import os" should be placed before "import requests"

import json

standard import "import json" should be placed before "import requests"

from dotenv import load_dotenv
from LORIS.helper import is_response_success

Unable to import 'LORIS.helper'

logging.basicConfig(stream=sys.stdout, level=logging.INFO)
logger = logging.getLogger('LORISQuery')

The name logger does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

def login():
    """
    Logs into LORIS using the stored credential. Must use PyCurl as Requests is not working.
    :return: BOOL if or not it is successful. also, the JSON token that is necessary to conduct further transactions.

This line is too long as per the coding-style (117/100).

    """
    logger = logging.getLogger('LORIS_login')

logger is re-defining a name which is already available in the outer-scope (previously defined on line 11).

    #Load environmental variables.
    load_dotenv()

    username = os.getenv("LORISusername")
    password = os.getenv("LORISpassword")

    data = json.dumps({"username":username, "password":password})

    #Login URL
    url = os.getenv("LORISurl")
    updated_url = url + 'login'


    # requests style login # NOT WORKING!
    r = requests.post(updated_url, data=data)

The name r does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    logger.info(str(r.status_code) + r.reason)

    response_json = r.json()

    return is_response_success(r.status_code, 200), response_json.get('token')


def getCNBP(token, endpoint):

This code seems to be duplicated in your project.

The name getCNBP does not conform to the function naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

token is re-defining a name which is already available in the outer-scope (previously defined on line 122).

    """
    Get from a CNBP LORIS database endpoint
    :param endpoint:
    :return: bool on if such PSCID (INSTITUTIONID + PROJECTID + SUBJECTID) exist already.
    """
    logger = logging.getLogger('LORIS_get')

logger is re-defining a name which is already available in the outer-scope (previously defined on line 11).

    logger.info("Getting LORIS endpoing: "+ endpoint + "at")
    load_dotenv()
    url = os.getenv("LORISurl")
    updatedurl = url + endpoint
    logger.info(updatedurl)
    HEADERS = {'Authorization': 'token {}'.format(token)}

The name HEADERS does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    with requests.Session() as s:

The name s does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        s.headers.update(HEADERS)
        r = s.get(updatedurl)

The name r does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        logger.info("Get Result:" + str(r.status_code) + r.reason)

        return r.status_code, r.json()


def postCNBP(token, endpoint, data):

This code seems to be duplicated in your project.

The name postCNBP does not conform to the function naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

token is re-defining a name which is already available in the outer-scope (previously defined on line 122).

    """
    post some data to a LORIS end point.
    :param endpoint:
    :param data:
    :return: bool on if request is successful, r for the request (CAN BE NULL for 201 based requests)

This line is too long as per the coding-style (101/100).

    """
    logger = logging.getLogger('LORIS_post')

logger is re-defining a name which is already available in the outer-scope (previously defined on line 11).

    logger.info("Posting data to: "+endpoint)
    logger.info("Data: "+data)
    logger.info("!!!!!!!!!!BEWARE THAT SOME ENDPOINTS HAVE TRAILING SLASH, OTHERS DON'T.!!!!!!!!!!!!!!")

This line is too long as per the coding-style (104/100).

    load_dotenv()
    url = os.getenv("LORISurl")
    updatedurl = url + endpoint

    HEADERS = {'Authorization': 'token {}'.format(token)}

The name HEADERS does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    with requests.Session() as s:

The name s does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        s.headers.update(HEADERS)
        r = s.post(updatedurl, data=data)

The name r does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        logger.info("Post Result:" + str(r.status_code) + r.reason)

        return r.status_code, r

def putCNBP(token, endpoint, data):

This code seems to be duplicated in your project.

The name putCNBP does not conform to the function naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

token is re-defining a name which is already available in the outer-scope (previously defined on line 122).

    """
    Put some data to a LORIS end point.
    :param endpoint:
    :param data:
    :return: bool on if request is successful, r for the request (CAN BE NULL for 201 based requests)

This line is too long as per the coding-style (101/100).

    """
    logger = logging.getLogger('LORIS_put')

logger is re-defining a name which is already available in the outer-scope (previously defined on line 11).

    logger.info("Putting data to: "+endpoint)
    logger.info("Data: "+data)
    logger.info("!!!!!!!!!!BEWARE THAT SOME ENDPOINTS HAVE TRAILING SLASH, OTHERS DON'T.!!!!!!!!!!!!!!")

This line is too long as per the coding-style (104/100).

    load_dotenv()
    url = os.getenv("LORISurl")
    updatedurl = url + endpoint

    HEADERS = {'Authorization': 'token {}'.format(token)}

The name HEADERS does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    with requests.Session() as s:

The name s does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        s.headers.update(HEADERS)
        r = s.put(updatedurl, data=data)

The name r does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        logger.info("Put Result:" + str(r.status_code) + r.reason)

        return r.status_code, r



# Only executed when running directly.
if __name__ == '__main__':
    #print(login())
    #getCNBP("projects")
    Success, token = login()

The name Success does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

The name token does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

    #print("Test complete")

Final newline missing