Tests and Updates by s2t2 · Pull Request #41 · stanfordio/truthbrush

s2t2 · 2024-10-11T22:24:28Z

Maintenance Updates

Implements Continuous Integration using GitHub Actions, to run tests on CI server. To make this work, you need to set the environment variables as repository secrets (see README.md). See working example here: https://github.com/s2t2/truthbrush/actions
Updates to Python 3.10:

poetry env use 3.10

Splits API tests into resource-specific test files, to stay organized.

Functionality Updates

Improves documentation and performance of the pull_statuses method. Makes user_name an optional parameter. Removes unnecessary API call using the username - if a user_id is supplied it uses the user_id in the request instead.
Improves documentation for the search method, designating which resources are valid (closes How to get a group id? #42 ).
Adds a simplified search method (search_simple) which returns only the resources requested.
Adds a datetime conversion utility function which is helpful when asking for posts after a given datetime.

s2t2 · 2024-10-13T16:49:56Z

+      env:
+        # set environment variables using repo secrets
+        TRUTHSOCIAL_USERNAME: ${{ secrets.TRUTHSOCIAL_USERNAME }}
+        TRUTHSOCIAL_PASSWORD: ${{ secrets.TRUTHSOCIAL_PASSWORD }}


These values need to be set on the upstream repo, using the repository secrets menu in the settings.

Maybe the login isn't really needed: #32

Seems like that's maybe a change from when we first built the tool. Pretty sure it used to all be authwalled.

Passing the username and password allows us to test auth-walled functionality.

We can use a new test account if concerned about security.

s2t2 · 2024-10-13T16:56:25Z

    def user_likes(
        self, post: str, include_all: bool = False, top_num: int = 40
-    ) -> bool | Any:
+    ) -> Union[bool, Any]:


Fixes error by using Union

hmm, bool | Any is equivalent to Any; also, the return type of this function doesn't make sense to me — shouldn't this return a list of some sort?

I am not sure about type hints or this function specifically. I had run into an issue with bool | Any and that was the suggested change. I'm happy to try changing it back.

s2t2 · 2024-10-13T16:57:22Z

        query: str = None,
        limit: int = 40,
-        resolve: bool = 4,
+        resolve: bool = 4, # bool = 4 ?


FYI not sure if bool type and default value of 4 are compatible?

I was the one who mistakenly introduced this: 1c74a96#diff-b8a4f09258d1b070faf6806097b4e7047930f99777e63d753dc1b03e7eae31a4R117

Needs to be changed ofc.

OK I will change to int

Just curious, what does the resolve do?

No, it needs to be a boolean (defaulted to True). Not sure what it does, changing from true to false does not change the output at all.

The params I get when executing a search in TS website are:

params = { 'q': 'trump', 'limit': '20', 'resolve': 'true', 'type': 'accounts', }

So probably resolve needs to be 'true' if resolve else 'false' in the HTTP req. 1c74a96#diff-b8a4f09258d1b070faf6806097b4e7047930f99777e63d753dc1b03e7eae31a4R124

s2t2 · 2024-10-13T16:57:37Z

                )

-            offset += 40
+            offset += 40 # use limit here?


should this be referencing the limit?

s2t2 · 2024-10-13T17:00:35Z

FYI this PR is ready for review anytime. Takes some tests and docstring updates from #38 , as requested.

s2t2 · 2024-10-13T18:05:13Z

-from datetime import datetime, timezone, date
+from datetime import datetime, timezone #, date
 from curl_cffi import requests
+import curl_cffi


fixes error by importing this package

s2t2 · 2024-10-13T18:06:49Z


        params = {}
-        user_id = self.lookup(username)["id"]
+        user_id = user_id or self.lookup(username)["id"]


skips separate request when able

s2t2 · 2024-10-13T18:09:44Z

        query: str = None,
        limit: int = 40,
-        resolve: bool = 4,
+        resolve: int = 4,


updates type hint

s2t2 · 2024-10-13T18:12:37Z

+
+
+@pytest.fixture(scope="module")
+def user_timeline(client):


FYI fixtures defined in the conftest.py can get referenced by test functions in other files.

milesmcc · 2024-10-13T18:58:16Z

Thanks! Ack, will review shortly.

Co-authored-by: Konrad Iturbe <KonradIT@users.noreply.github.com>

s2t2 · 2024-10-22T16:31:57Z

I have started to see some cloudflare restricted pages. I assume when making too many requests in too short a period of time. But does anyone know what the logic is for when they appear?

@v5

Public/unauthenticated mode (closes #32) - Api gains keyword-only require_auth=True parameter; default preserves strict behavior so no existing caller changes. - __check_login early-returns when require_auth=False and no token is present, instead of raising LoginErrorException. - _get and _get_paginated omit the Authorization header when auth_id is None. Sending no header beats sending "Bearer None". - CLI: --no-auth global flag on the group, Api constructed once via ctx.obj["api"]; all 13 commands take click.Context via pass_context. Verified end-to-end: `truthbrush --no-auth user realDonaldTrump` returns JSON; `truthbrush trends` (strict, no creds) still raises. Python 3.14 - pyproject.toml: python = "^3.14"; ruff target-version = "py314". - Workflow: actions/setup-python bumped to @v5 with python-version: 3.14 (3.10-dev was a stale pre-release pin). - Ruff auto-fix pass: timezone.utc -> UTC; stale quoted forward-ref on date_to_bound unquoted. Type hygiene - ty check truthbrush/ goes from 35 pre-existing diagnostics to zero: x: T = None defaults -> X | None = None throughout; generator return types -> Iterator[T]; datetime.utcnow() -> datetime.now(UTC); ratelimit_reset null-guarded; sorted() over JSON payload narrowed via cast(list[dict], result); pull_statuses result-shape validation reordered so a non-list response breaks the loop instead of crashing in sorted(). Drive-bys cherry-picked from PR #41 - search(resolve: bool = 4) -> True. Default was an int despite the bool annotation. - pull_statuses(username=None, ..., *, user_id=None): either identifier works; supplying user_id directly skips the lookup roundtrip, which matters in public mode where lookup may be gated. Also calls __check_login explicitly (previously relied on transitive call). Tests - Two offline tests: one asserts Api(require_auth=False) without creds does not raise on a method call that short-circuits before HTTP; one asserts the default strict mode still raises LoginErrorException without creds. Both use monkeypatch.delenv to guard against a loaded .env. README - New "Public mode (no credentials)" subsection under Installation. - --no-auth added to the help block. - Stale "Please format your code with black" replaced with the ruff/ty workflow introduced in 0.3.0. Authors - pyproject.toml authors gains David Thiel.

@v5

Public/unauthenticated mode (closes #32) - Api gains keyword-only require_auth=True parameter; default preserves strict behavior so no existing caller changes. - __check_login early-returns when require_auth=False and no token is present, instead of raising LoginErrorException. - _get and _get_paginated omit the Authorization header when auth_id is None. Sending no header beats sending "Bearer None". - CLI: --no-auth global flag on the group, Api constructed once via ctx.obj["api"]; all 13 commands take click.Context via pass_context. Verified end-to-end: `truthbrush --no-auth user realDonaldTrump` returns JSON; `truthbrush trends` (strict, no creds) still raises. Python 3.14 - pyproject.toml: python = "^3.14"; ruff target-version = "py314". - Workflow: actions/setup-python bumped to @v5 with python-version: 3.14 (3.10-dev was a stale pre-release pin). - Ruff auto-fix pass: timezone.utc -> UTC; stale quoted forward-ref on date_to_bound unquoted. Type hygiene - ty check truthbrush/ goes from 35 pre-existing diagnostics to zero: x: T = None defaults -> X | None = None throughout; generator return types -> Iterator[T]; datetime.utcnow() -> datetime.now(UTC); ratelimit_reset null-guarded; sorted() over JSON payload narrowed via cast(list[dict], result); pull_statuses result-shape validation reordered so a non-list response breaks the loop instead of crashing in sorted(). Drive-bys cherry-picked from PR #41 - search(resolve: bool = 4) -> True. Default was an int despite the bool annotation. - pull_statuses(username=None, ..., *, user_id=None): either identifier works; supplying user_id directly skips the lookup roundtrip, which matters in public mode where lookup may be gated. Also calls __check_login explicitly (previously relied on transitive call). Tests - Two offline tests: one asserts Api(require_auth=False) without creds does not raise on a method call that short-circuits before HTTP; one asserts the default strict mode still raises LoginErrorException without creds. Both use monkeypatch.delenv to guard against a loaded .env. README - New "Public mode (no credentials)" subsection under Installation. - --no-auth added to the help block. - Stale "Please format your code with black" replaced with the ruff/ty workflow introduced in 0.3.0. Authors - pyproject.toml authors gains David Thiel.

lxcode · 2026-04-20T11:30:23Z

Ok sorry to leave this sitting a while, but I've pulled a couple fixes from here and hopefully some other things have been resolved along the way

s2t2 added 3 commits October 11, 2024 18:06

Cherry pick updates from docs branch

9003173

Helper function

34767f4

Tests WIP

e5643ee

This comment was marked as outdated.

Sign in to view

s2t2 added 6 commits October 11, 2024 19:47

Running into auth errors

3eb155e

CI

7764483

Fix CI

472f8ef

Fix CI

1e98840

Fix linting error

7a90dd1

Run black formatter

4ccd663

s2t2 marked this pull request as ready for review October 13, 2024 15:55

s2t2 mentioned this pull request Oct 13, 2024

How to get a group id? #42

Closed

lxcode requested a review from milesmcc October 13, 2024 16:18

Test and document groups

efe2a1d

s2t2 changed the title ~~Pull Statuses - Username Optional~~ Tests and Updates Oct 13, 2024

s2t2 commented Oct 13, 2024

View reviewed changes

Comment thread truthbrush/api.py

s2t2 commented Oct 13, 2024

View reviewed changes

Comment thread truthbrush/api.py

s2t2 commented Oct 13, 2024

View reviewed changes

Update parameter type hint

0ca5209

s2t2 commented Oct 13, 2024

View reviewed changes

Improve test to work if sort order changes

4f3860a

KonradIT reviewed Oct 13, 2024

View reviewed changes

Comment thread truthbrush/api.py

s2t2 force-pushed the more-tests branch from 236a8ff to 4f3860a Compare October 14, 2024 01:02

Update truthbrush/api.py

86df3e9

Co-authored-by: Konrad Iturbe <KonradIT@users.noreply.github.com>

Update api.py

e1c0d00

lxcode mentioned this pull request Apr 20, 2026

Public mode, Python 3.14, clean ty #74

Merged

lxcode mentioned this pull request Apr 20, 2026

Release 0.4.0 #75

Merged

lxcode closed this Apr 20, 2026

Conversation

s2t2 commented Oct 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Maintenance Updates

Functionality Updates

Uh oh!

This comment was marked as outdated.

s2t2 Oct 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s2t2 Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

s2t2 commented Oct 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

milesmcc commented Oct 13, 2024

Uh oh!

Uh oh!

s2t2 commented Oct 22, 2024

Uh oh!

lxcode commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

s2t2 commented Oct 11, 2024 •

edited

Loading

s2t2 Oct 13, 2024 •

edited

Loading

s2t2 Oct 22, 2024 •

edited

Loading