Перейти к публикации

[SOURCE] Python SDK - vimeapi


Рекомендованные сообщения

Опубликовано:

штош...

 

Я ещё не писал подобных коментов (назвать мой поток мыслей кодревью даже язык не поворачивается, если честно), но можно попробовать, т.к. в Python ощущаю себя, как рыба в воде.

 

  • Форматирование кода. Ты не следуешь ни одной конвенции форматирования, код читается не сложно, но чрезвычайно неприятно смотреть на кучу пробелов, импорты через запятую. Посмотри и изучи PEP8, будет полезно в дальнейшем изучении языка.
  • HTTP запросы. Ты использовал довольно примитивную библиотеку для реализации кода. Да, она built-in, но есть альтернативы: httpx, aiohttp (класс ClientSession). Я бы вообще посоветовал погрузиться в асинхронщину, если работаешь с web. На практике асинхронный код работает шустрее, надёжнее в Python (но тут не без подводных камней).
  • Исключения. Не буду врать, но это просто ужасная обработка ошибок! Почему ты не поднимаешь исключения, а просто решил пойти методом возврата истина/ложь? Использовать исключения гораздо удобнее и практичнее, в них можно поместить подробную информацию об ошибке, проще отловить конкретную ошибку и, например, игнорировать её.
  • Точно библиотека? Это не библиотека. Тут как ни крути, библиотекой или SDK это назвать сложно. Ты не создал ни одного механизма настройки кода (ввод токена, ссылки на API), что уже порождает вопрос: а для чего этот код мне, если мне всё-равно нужно будет возиться в исходнике? 
  • PEP257. Отсутствуют docstrings (PEP257). Что тут ни говори, но подсказки в коде нужны. Я не говорю, что тут необходимо юзать какой-нибудь сфинкс и генерировать документацию, нет, вовсе нет. Обычные строки, объясняющие суть каждой функции, могут облегчить процесс разработки.
  • ReadMe.md Файл выглядит очень пустым, информации о том, как применять данный код просто нет. 

 

Вообще, здорово, что ты пытаешься что-то писать, но опыта всё-таки стоит поднабраться :) Ещё очень посоветую найти какую-нибудь популярную библиотечку, порыться в исходниках. Желаю тебе удачки в изучении!

Опубликовано:

штош...

 

Я ещё не писал подобных коментов (назвать мой поток мыслей кодревью даже язык не поворачивается, если честно), но можно попробовать, т.к. в Python ощущаю себя, как рыба в воде.

 

  • Форматирование кода. Ты не следуешь ни одной конвенции форматирования, код читается не сложно, но чрезвычайно неприятно смотреть на кучу пробелов, импорты через запятую. Посмотри и изучи PEP8, будет полезно в дальнейшем изучении языка.
  • HTTP запросы. Ты использовал довольно примитивную библиотеку для реализации кода. Да, она built-in, но есть альтернативы: httpx, aiohttp (класс ClientSession). Я бы вообще посоветовал погрузиться в асинхронщину, если работаешь с web. На практике асинхронный код работает шустрее, надёжнее в Python (но тут не без подводных камней).
  • Исключения. Не буду врать, но это просто ужасная обработка ошибок! Почему ты не поднимаешь исключения, а просто решил пойти методом возврата истина/ложь? Использовать исключения гораздо удобнее и практичнее, в них можно поместить подробную информацию об ошибке, проще отловить конкретную ошибку и, например, игнорировать её.
  • Точно библиотека? Это не библиотека. Тут как ни крути, библиотекой или SDK это назвать сложно. Ты не создал ни одного механизма настройки кода (ввод токена, ссылки на API), что уже порождает вопрос: а для чего этот код мне, если мне всё-равно нужно будет возиться в исходнике? 
  • PEP257. Отсутствуют docstrings (PEP257). Что тут ни говори, но подсказки в коде нужны. Я не говорю, что тут необходимо юзать какой-нибудь сфинкс и генерировать документацию, нет, вовсе нет. Обычные строки, объясняющие суть каждой функции, могут облегчить процесс разработки.
  • ReadMe.md Файл выглядит очень пустым, информации о том, как применять данный код просто нет. 

 

Вообще, здорово, что ты пытаешься что-то писать, но опыта всё-таки стоит поднабраться :) Ещё очень посоветую найти какую-нибудь популярную библиотечку, порыться в исходниках. Желаю тебе удачки в изучении!

Евгений Сергеевич, это вы?  :blink:

Опубликовано:

штош...

 

Я ещё не писал подобных коментов (назвать мой поток мыслей кодревью даже язык не поворачивается, если честно), но можно попробовать, т.к. в Python ощущаю себя, как рыба в воде.

 

  • Форматирование кода. Ты не следуешь ни одной конвенции форматирования, код читается не сложно, но чрезвычайно неприятно смотреть на кучу пробелов, импорты через запятую. Посмотри и изучи PEP8, будет полезно в дальнейшем изучении языка.
  • HTTP запросы. Ты использовал довольно примитивную библиотеку для реализации кода. Да, она built-in, но есть альтернативы: httpx, aiohttp (класс ClientSession). Я бы вообще посоветовал погрузиться в асинхронщину, если работаешь с web. На практике асинхронный код работает шустрее, надёжнее в Python (но тут не без подводных камней).
  • Исключения. Не буду врать, но это просто ужасная обработка ошибок! Почему ты не поднимаешь исключения, а просто решил пойти методом возврата истина/ложь? Использовать исключения гораздо удобнее и практичнее, в них можно поместить подробную информацию об ошибке, проще отловить конкретную ошибку и, например, игнорировать её.
  • Точно библиотека? Это не библиотека. Тут как ни крути, библиотекой или SDK это назвать сложно. Ты не создал ни одного механизма настройки кода (ввод токена, ссылки на API), что уже порождает вопрос: а для чего этот код мне, если мне всё-равно нужно будет возиться в исходнике? 
  • PEP257. Отсутствуют docstrings (PEP257). Что тут ни говори, но подсказки в коде нужны. Я не говорю, что тут необходимо юзать какой-нибудь сфинкс и генерировать документацию, нет, вовсе нет. Обычные строки, объясняющие суть каждой функции, могут облегчить процесс разработки.
  • ReadMe.md Файл выглядит очень пустым, информации о том, как применять данный код просто нет. 

 

Вообще, здорово, что ты пытаешься что-то писать, но опыта всё-таки стоит поднабраться :) Ещё очень посоветую найти какую-нибудь популярную библиотечку, порыться в исходниках. Желаю тебе удачки в изучении!

1. На счет импортировании библиотек через запятую - я не считаю это "неприятным" или нечитабельным

2. Считаю что нет смысла в использовании других пакетов, requests простой и для этой задачи он сойдет

3. Нет смысла отлавливать определенные ошибки, я в любом случае вывожу дебаг инфу о коде с сайта (Но все равно задумался, и подробнее изучу этот вопрос)

4. SDK - это набор инструментов для разработки, по этому я считаю что могу назвать это SDK

5. Смысла в примерах нет, есть отдельный файл как начать работу. Да, я мог сделать подсказку для функций, но 95% называется так же как и метод в API. А pycharm вообще может подсказать функцию вместе с аргументами просто начав писать название. В любом случае да, я могу признать что это не совсем SDK, и использование будет "непонятным" по началу

Спасибо за фидбек, сделал вывод что мне нужно подучить

Опубликовано:

1. На счет импортировании библиотек через запятую - я не считаю это "неприятным" или нечитабельным

2. Считаю что нет смысла в использовании других пакетов, requests простой и для этой задачи он сойдет

3. Нет смысла отлавливать определенные ошибки, я в любом случае вывожу дебаг инфу о коде с сайта (Но все равно задумался, и подробнее изучу этот вопрос)

4. SDK - это набор инструментов для разработки, по этому я считаю что могу назвать это SDK

5. Смысла в примерах нет, есть отдельный файл как начать работу. Да, я мог сделать подсказку для функций, но 95% называется так же как и метод в API. А pycharm вообще может подсказать функцию вместе с аргументами просто начав писать название. В любом случае да, я могу признать что это не совсем SDK, и использование будет "непонятным" по началу

Спасибо за фидбек, сделал вывод что мне нужно подучить

чел твоим "sdk" энивей никто никогда пользоваться не будет, можешь смело удалять тему

Создайте аккаунт или войдите в него для комментирования

Вы должны быть пользователем, чтобы оставить комментарий

Создать аккаунт

Зарегистрируйтесь для получения аккаунта. Это просто!

Зарегистрировать аккаунт

Войти

Уже зарегистрированы? Войдите здесь.

Войти сейчас
  • Сейчас на странице   0 пользователей

    • Нет пользователей, просматривающих эту страницу.
×
×
  • Создать...