Return a new client with SyftClient.login

[kiendang]

Description

Make SyftClient.login return a new SyftClient instance instead of mutating the current SyftClient instance.

Short changelog example

Before

import syft as sy
guest_client = sy.login(url="", port="")
guest_client.login(...)

# use `guest_client` as the logged in `SyftClient`
guest_client.upload_dataset(...)

After

import syft as sy
guest_client = sy.login_as_guest(url="http://localhost", port="8081")
client = guest_client.login(email="[email protected]", password="changethis")

# use `client` as the logged in `SyftClient` instead of `guest_client`
client.upload_dataset(...)

Before

import syft as sy
# Email and password can be empty and we can proceed to login as guest
guest_client = sy.login(url="http://localhost", port="8081")
guest_client.datasets

After

import syft as sy
# Email is a required field when calling login
client = sy.login(url="http://localhost", port="8081", email="[email protected]", password="changethis")
# To Login as Guest
guest_client = sy.login_as_guest(url="http://localhost", port="8081")

Long changelog example

Before

import syft as sy

node = sy.orchestra.launch(name="test-domain-1", port="auto")
guest_domain_client = node.client

client = guest_domain_client.login(email="[email protected]")

new_project = sy.Project(
    name="my project",
    description="project description",
    members=[client],
)

new_project.start()

project = client.get_project(name="my project")

After

import syft as sy

node = sy.orchestra.launch(name="test-domain-1", port="auto")
guest_client = node.client

guest_client.login(email="[email protected]")

new_project = sy.Project(
    name="my project",
    description="project description",
    members=[guest_client],
)

new_project.start()

project = guest_client.get_project(name="my project")

Affected Dependencies

List any dependencies that are required for this change.

How has this been tested?

• Describe the tests that you ran to verify your changes.
• Provide instructions so we can reproduce.
• List any relevant details for your test configuration.

Checklist

• I have followed the Contribution Guidelines and Code of Conduct
• I have commented my code following the OpenMined Styleguide
• I have labeled this PR with the relevant Type labels
• My changes are covered by tests

[shubham3121]

Nice work @kiendang !!

[tcp]

How is a failed login attempt handled?

[kiendang]

It would return a SyftError

_client = ...
if isinstance(_client, SyftError): return _client

return _client

in both cases we return _client so that check is not needed here

[tcp]

Dropped a question about handling failed login attempts. Overall, nice work!

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[madhavajay]

@kiendang Can we get a changelog example for the Product Team. For example:

# old code example

# new code example

[kiendang]

@madhavajay where should the changelog example be put in?

[kiendang]

@madhavajay I put the changelog examples in the description of the PR. 1 short concise example to highlight the change and 1 longer fully runnable one.

[madhavajay]

@kiendang this is really great work! Thank you for your diligence in addressing all the tests as well. 👏 We are still figuring out how to hand off these kinds of API changes but I think it helps to have some code examples for @IrinaMBejan Pylot team.